Request Sequences

Request sequences define a series of steps (questions, approval tasks, and custom tasks) that must be completed for a requester to gain access.

Request sequences can be re-used across many request conditions.

A request condition must refer to one request sequence.

The following request sequence APIs may be used to retrieve request sequence data necessary for managing request conditions.

See Configure an approval sequence for more information on using sequences with request conditions.

List all resource request sequences
Beta
Admin permissions required: Access Requests Administrator
OAuth 2.0: okta.accessRequests.condition.read

Lists access request sequences for a resource in your org

Request
path Parameters
resourceId
required
string

The id of the resouce in okta id format or ORN format

Responses
200

A successful request sequences list response

401

When authentication fails

403

When authorization fails

404

When the requested resource was not found

429

When the rate limit has been exceeded

500

When there is a server fault due to an unexpected error

get/governance/api/v2/resources/{resourceId}/request-sequences
Request samples
Response samples
application/json

Access request sequences that are returned from a get call

{}

Retrieve a resource request sequence
Beta
Admin permissions required: Access Requests Administrator
OAuth 2.0: okta.accessRequests.condition.read

Retrieves a access request sequence referenced by the specified resource

Request
path Parameters
resourceId
required
string

The id of the resouce in okta id format or ORN format

sequenceId
required
string <sequence-id> = 24 characters

The id of the sequence

Responses
200

A successful request sequence get response

401

When authentication fails

403

When authorization fails

404

When the requested resource was not found

429

When the rate limit has been exceeded

500

When there is a server fault due to an unexpected error

get/governance/api/v2/resources/{resourceId}/request-sequences/{sequenceId}
Request samples
Response samples
application/json

Access request sequence that are returned from a get call by sequence id

{}

Delete a request sequence
Beta
Admin permissions required: Access Requests Administrator
OAuth 2.0: okta.accessRequests.condition.manage

Deletes the access request sequence given its id

Request
path Parameters
sequenceId
required
string <sequence-id> = 24 characters

The id of the sequence

Responses
204

A successful request sequence delete response

401

When authentication fails

403

When authorization fails

404

When the requested resource was not found

429

When the rate limit has been exceeded

500

When there is a server fault due to an unexpected error

delete/governance/api/v2/request-sequences/{sequenceId}
Request samples
Response samples
application/json
{
  • "errorCode": "E0000004",
  • "errorSummary": "Authentication failed.",
  • "errorLink": "E0000004",
  • "errorId": "oaeWCGz73hpRCG75VHP6-RRXw",
  • "errorCauses": [ ]
}