See api-docs Menu

Update a Rule

Use this API to perform a full or partial update on a rule that has been created in the Risk Sevice.

10 Minute Cache

Vigilance AI has a 10 minute cache for loading rules. This means that any rules that are updated may not come into effect for up to 10 minutes.




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 Parameter

id

required

string

The ID of the rule to update.

Request Parameters

id

required

string

The ID of the rule to update.

Sample Request Body

{
  "filters": ["123.123.123.123", "1.1.1.1"]
}

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", "1.1.1.1"]
}

No Content

No Content

Sample Code

cURL

curl -XPUT 'https://api.us.onelogin.com/api/2/risk/rules/234677874491720987' \
  -H 'Authorization: Bearer xxxxxxxxxxxxx'
  -H "Content-Type: application/json" \
  -d '{
      "name": "updated rule name"
}'

Postman Collection

Replace sample variables indicated by {{ }} with your actual values.

Download for the Vigilance API


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.