See api-docs Menu

List Actions

Use this API to return a list of the actions that can be applied when an App Rule runs.

Use the Action Value when creating or updating rules.

The list of conditions will also include any Custom Attributes that have been defined in a OneLogin account.








Resource URL

https://<api-domain>/api/2/apps/:app_id/rules/actions

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.

Sample Responses

[
    {
        "name": "Set Role",
        "value": "add_role"
    },
    {
        "name": "Set Status",
        "value": "set_status"
    },
    {
        "name": "Set Employee ID",
        "value": "set_employee_id"
    },
    ...
]

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

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

Response Elements

name The name of the Action.
value The unique identifier of the action. This should be used when defining actions for a User Mapping.

Postman Collection

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

Download for the Apps Rules API

Sample Code

cURL

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

List Rule Actions

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

Have a Question?

Found a bug? Submit a support ticket.

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