Create Rule
Use this API to create an a new App Rule.
Resource URL
https://<api-domain>/api/2/apps/:app_id/rules
Header Parameters
Authorization required string | Set to Set 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: |
Content-Type required string |
Set to application/json . |
Request Parameters
app_id required integer | The id of the application that where the rules apply. |
|
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.
|
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 rule to be applied.
|
Array |
actions
required |
An array of actions that will be applied to the users that are matched by the conditions.
|
Array |
Sample Request Body
With a standard action
{
"name": "My Second Rule",
"match": "all",
"enabled": true,
"position": null,
"conditions": [
{
"source": "last_login",
"operator": ">",
"value": "90"
}
],
"actions": [
{
"action": "set_status",
"value": ["2"]
}
]
}
Using an expression in an action
{
"name": "My Second Rule",
"match": "all",
"enabled": true,
"position": null,
"conditions": [
{
"source": "has_role",
"operator": "ri",
"value": "123456"
}
],
"actions": [
{
"action": "set_groups",
"value": ["member_of"],
"expression": "/.*/"
}
]
}
With a scriplet action
{
"name": "My Second Rule",
"match": "all",
"enabled": true,
"position": null,
"conditions": [
{
"source": "last_login",
"operator": ">",
"value": "90"
}
],
"actions": [
{
"action": "set_filteredgroups",
"scriplet": "4a77bdeb87652d78db...."
}
]
}
Sample Responses
- 201 Created
- 401 Unauthorized
- 422 Unprocessable Entity
{
"id": 1022743
}
Typically, this error means that your access token value is invalid.
{
"message": "Unauthorized",
"statusCode": 401,
"name": "UnauthorizedError"
}
{
"code": 422,
"message": "Validation Failed",
"errors": [
{
"field": "enabled",
"message": [
"Required field is missing"
]
}
]
}
An invalid condition value was supplied
{
"code": 422,
"message": "Validation Failed",
"errors": [
{
"field": "conditions.[0].value",
"message": [
"Invalid condition value: 12345"
]
}
]
}
Response Elements
id |
New App Rule ID. |
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.
Create a Rule
curl 'https://<api-domain>/api/2/apps/:app_id/rules' \
-X POST \
-H "Authorization: bearer <access_token>"
-H "Content-Type: application/json" \
-d '{
"name": "My Second Rule",
"match": "all",
"enabled": true,
"position": null,
"conditions": [
{
"source": "last_login",
"operator": ">",
"value": "90"
}
],
"actions": [
{
"action": "set_status",
"value": "2"
}
]
}'
Have a Question?

Found a bug? Submit a support ticket.

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