See api-docs Menu
  1. Home >
  2. API >
  3. 2 >
  4. App Rules >
  5. Get Rule

Get Rule

Use this API to return a single app rule configuration.








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.

Resource Parameters

app_id

required

integer

The id of the application that where the rules apply.

id

required

integer

The id of the app rule to locate.

Sample Responses

  • 200 OK
  • 401 Unauthorized
  • 404 Not Found
{
  "id": 196670,
  "name": "My First rule",
  "match": "all",
  "enabled": true,
  "position": 1,
  "conditions": [
      {
          "source": "has_role",
          "operator": "ri",
          "value": "909876"
      }
  ],
  "actions": [
      {
          "action": "set_groups",
          "value": [
              "member_of"
          ],
          "expression": ".*"
      }
  ]
}

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

{
    "message": "Unauthorized",
    "statusCode": 401,
    "name": "UnauthorizedError"
}
{
    "message": "The resource with the given id could not be found",
    "statusCode": 404,
    "name": "NotFoundError"
}

Postman Collection

Run In Postman

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.

Get a Rule

curl 'https://<subdomain>/api/2/apps/:app_id/rules/:id' \
-X GET \
-H "Authorization: bearer <access_token>"

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.