See api-docs Menu
  1. Home >
  2. API >
  3. 2 >
  4. Vigilance AI >
  5. Get a Rule

Get a Rule

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






Resource URL

https://<subdomain>/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

  • 200 OK
  • 401 Unauthorized
{
  "id": "132456789",
  "name": "IP Blocklist for Guests",
  "description": "Blocklist 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://<subdomain>.onelogin.com/api/2/risk/rules/234677874491720987' \
  -H 'Authorization: Bearer xxxxxxxxxxxxx'

Postman Collection

Run In Postman

    Clicking Run in Postman button navigates to the page where you can fork the collection to your workspace. Forking the collection into your workspace will enable you to contribute to the source collection using pull requests. You can also view the collection in a public workspace if you like and even import a copy of the collection using the links present on the screen.

Have a Question?

Found a problem or a bug? Submit a support ticket.

Looking for walkthroughs or how-to guides on OneLogin's user and admin features? Check out the documentation in our Knowledge Base.

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