See api-docs Menu

App Rules

The App Rules API can be used to list, create, update, re-order, and delete mapping rules for a OneLogin application.

App Rules in OneLogin enable you to automate changes to parameters, user attributes, and application entitlements based on conditions that you define. For example, you might use rules to map roles with their equivalent entitlement in a application that is accessed via SSO.

Reapply Entitlement Mappings

Rules will not be automatically applied when they modified via this API.

Either a User must be created/updated or “Reapply Entitlement Mappings” must be run via UI to trigger the rules to run.

Refresh Entitlements

Entitlements will not be automatically refreshed when an App is created. This action must be performed via Admin UI.

Parts of a Rule

A rule is similar to an “if this then that” concept where the “this” is a condition and the “that” is the action to take.

Depending on the setting of the match attribute, one or more conditions must be met in order for the mapping action(s) to be applied.

Conditions

A condition is an object that consists of a source, an operator, and a value.

{
    "source": "member_of",
    "operator": "~",
    "value": "SECURITY-GROUP-1"
}

The list of possible condition sources is available using the list conditions endpoint. The list of possible operators changes with the condition that is selected. The same is true for the list of condition values.

When no condition values are returned this indicates that free text is accepted.

Actions

An action is an object that consists of a action, and a value.

{
    "action": "add_role",
    "value": "272444"
}

Similar to conditions, all possible actions can be retrieved using the list actions endpoint. The list of possible values changes based on the action that is selected.

When no actions values are returned this indicates that free text is accepted.

Create a mapping

For example, you can create a rule that controls what a user can do in Office 365 based on their role in OneLogin.

curl 'https://<api-domain>/api/2/mappings' \
-X POST \
-H "Authorization: bearer <access_token>"
-H "Content-Type: application/json" \
-d '{
    "name": "Assign a role",
    "match": "all",
    "enabled": true,
    "position": null,
    "conditions": [
        {
            "source": "has_role",
            "operator": "~",
            "value": "765432"
        }
    ],
    "actions": [
        {
            "action": "add_role",
            "value": "272444"
        }
    ]
}'

Postman Collection

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

Download for the Apps Rules API


Have a Question?

Found a bug? Submit a support ticket.

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