The Request Sequences API allows you to retrieve request sequence data necessary for managing request conditions. Request sequences are created in the Okta Access Requets app and define a series of steps (questions, approval tasks, and custom tasks) that must be completed for a requester to gain access to the resource.
When you create a request condition, you must reference a request sequence. You can reuse request sequences with many request conditions.
See Configure an approval sequence in the product documentation.
Note: Each org has a maximum of 250 request sequences.
Lists access request sequences for a resource in your org
| resourceId required | string The ID of the resource in Okta instance ID format or ORN format |
A successful request sequences list response
When authentication fails
When authorization fails
When the requested resource wasn't found
When the rate limit has been exceeded
When there is a server fault due to an unexpected error
Access request sequences that are returned from a get call
{- "data": [
- {
- "id": "61eb0f06c462d20007f051ac",
- "name": "No approver sequence",
- "description": "No approvers needed",
- "compatibleResourceTypes": [
- "APP"
],
}, - {
- "id": "61eb0f06c462d20007f124bq",
- "name": "Manager approval",
- "description": "Manager approval required",
- "compatibleResourceTypes": [
- "APP",
- "GROUP"
],
}
], - "_links": {
}
}Retrieves a access request sequence referenced by the specified resource
| resourceId required | string The ID of the resource in Okta instance ID format or ORN format |
| sequenceId required | string <sequence-id> = 24 characters The Example: 673b6e662088ea0006d10ff3 |
A successful request sequence get response
When authentication fails
When authorization fails
When the requested resource wasn't found
When the rate limit has been exceeded
When there is a server fault due to an unexpected error
Access request sequence that are returned from a get call by sequence id
{- "id": "61eb0f06c462d20007f051ac",
- "name": "No approver sequence",
- "description": "No approvers needed",
- "compatibleResourceTypes": [
- "APP",
- "GROUP"
],
}Deletes the access request sequence given its id
A successful request sequence delete response
When authentication fails
When authorization fails
When the requested resource wasn't found
When the rate limit has been exceeded
When there is a server fault due to an unexpected error
{- "errorCode": "E0000004",
- "errorSummary": "Authentication failed.",
- "errorLink": "E0000004",
- "errorId": "oaeWCGz73hpRCG75VHP6-RRXw",
- "errorCauses": [ ]
}