See api-docs Menu

Get a Rule

Use this API to return a single rule that has been created in the Risk Sevice.

Early Preview Release

This API is currently in early preview release and may be subject to future breaking changes. If you’re interested in using this API please contact your account manager or our support team.

Resource URL

https://api.<us_or_eu>.onelogin.com/api/2/risk/rules/<id>

Header Parameters

Authorization

required

string

Set to bearer:<access_token>.

Set <access_token> to the access token you generated using the Generate Token API.

The access token must have been generated using an API credential pair created using the scope required to call this API. This API can be called using any one of the following scopes: Read All, or Manage All.

Resource Parameters

id

required

string

The ID of the rule to retrieve.

Sample Response

{
  "id": "132456789",
  "name": "IP Blacklist for Guests",
  "description": "Blacklist for guest account users",
  "type": "blacklist",
  "target": "location.ip",
  "source": "guest-123",
  "filters": "123.123.123.123"
}

Invalid API Key

Sample Code

cURL

curl -XGET 'https://api.us.onelogin.com/api/2/risk/rules/234677874491720987' \
  -H 'Authorization: Bearer xxxxxxxxxxxxx'

Have a Question?

Have a how-to question? Seeing a weird error? Ask us about it on StackOverflow.

Found a bug? Submit a support ticket.

Have a product idea or request? Share it with us in our Ideas Portal.