Home >
API >
2 >
App Rules >
Update Rule

Update Rule

Use this API to update an existing App Rule.

Resource URL

https://<subdomain>/api/2/apps/:app_id/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: Manage All.

Content-Type

required

string

Set to application/json.

Resource Parameter

app_id

required

integer

The id of the application that where the rules apply.

required

integer

Set to the id of the rule that you want to update. If you do not know the id, use the List Rules API call to return all rules and their id values.

Request Parameters

Many of the search tools described in our Getting Started documentation can be applied to your parameters, allowing you to fine-tune your results.

name required	The name of the rule.	String
enabled required	Indicates if the rule is enabled or not.	Boolean
match required	Indicates how conditions should be matched. all - Match all conditions any - Match any condition	String
position required	Indicates the order of the rule. When `null` this will default to last position.	Integer
conditions required	An array of conditions that the user must meet in order for the mapping to be applied. source - The source field to check. See List Conditions for possible values. operator - A valid operator for the selected condition source. See List Condition Operators for possible values. value - A plain text string or valid value for the selected condition source. See List Condition Values for possible values.	Array
actions required	An array of actions that will be applied to the users that are matched by the conditions. action - The action to apply. See List Actions for possible values. value - A plain text string or valid value for the selected action. See List Action Values for possible values.	Array

Sample Request Body

{
    "name": "Suspend users after 120 days inactive",
    "match": "all",
    "enabled": true,
    "position": 1,
    "conditions": [
        {
            "source": "last_login",
            "operator": ">",
            "value": "120"
        }
    ],
    "actions": [
        {
            "action": "set_status",
            "value": "2"
        }
    ]
}

Sample Responses

200 OK
401 Unauthorized
422 Unprocessable Entity

{
  "id": 1022697
}

Typically, this error means that your access token value is invalid.

{
    "message": "Unauthorized",
    "statusCode": 401,
    "name": "UnauthorizedError"
}

ID should not be included in the payload body.

{
  "code": 422,
  "message": "Validation Failed",
  "errors": [
      {
          "field": "id",
          "message": [
              "Field is not allowed"
          ]
      }
  ]
}

Response Elements

`id`	Unique ID for app rule in OneLogin.

Postman Collection

The App Rules API Postman Collections are nested in the Apps API Collection folder in the Rules folder.

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.

Sample Code

cURL

Replace sample values indicated by < > with your actual values.

Update a Rule

curl 'https://<subdomain>/api/2/apps/:app_id/rules/:id' \
-X PUT \
-H "Authorization: bearer <access_token>"
-H "Content-Type: application/json" \
-d '{
    "name": "Suspend users after 120 days inactive",
    "match": "all",
    "enabled": true,
    "position": 1,
    "conditions": [
        {
            "source": "last_login",
            "operator": ">",
            "value": "120"
        }
    ],
    "actions": [
        {
            "action": "set_status",
            "value": ["2"]
        }
    ]
}'

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.