GET

Get a Rule

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

Resource URL

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

  • 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'
```xml

<h2 id="postman-collection">Postman Collection</h2>

[<img src=https://run.pstmn.io/button.svg alt="Run In Postman" style="width: 128px; height: 32px;">](https://god.gw.postman.com/run-collection/2629710-4ff52dab-63b4-4cae-9239-6c1a76e8ec00?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D2629710-4ff52dab-63b4-4cae-9239-6c1a76e8ec00%26entityType%3Dcollection%26workspaceId%3D2a9bbc3a-4259-4faf-9f51-0b7ca1df3fd0)