Approval Workflow

Manage the workflows that approve access requests.

📄️List approval workflows

Returns all approval workflows, each with its tiers and approvers. Use it to see which approval processes are defined.

📄️Create an approval workflow

Creates an approval workflow with its tiers, approvers and approver groups. Use it to define who must approve access requests and in what order.

Saves an approval workflow with its tiers and approvers. The tiers you send replace the stored ones: tiers left out of the request are deleted, and each tier's approvers and approver groups are replaced by the ones you send. If no workflow with the given ID exists, a new one is created.

📄️List approvals for an activity session

Returns the approval records for the given activity session across all tiers, showing who must approve and the state of each approval.

📄️Approve or deny an access request

Records an approver's decision and notes on every approval that approver holds for an activity session. The approval process then advances: a completed tier moves the workflow on, and if the combined result of the workflow becomes Denied, the approval process for the session is cancelled.

📄️Delete an approval

Deletes a single approval record from an approval workflow. The record is removed immediately; the call also returns 202 when no approval has that ID.

📄️Get an approval by ID

Returns one approval record, including its state and any notes from the approver.

📄️Search accounts and groups that can approve in a tier

Searches the accounts and groups that can be added as approvers to an approval tier, with paging, sorting and text filtering. Accounts and groups already assigned to the tier are left out, and applications and collections are never returned. Use it to populate an approver picker.

📄️Get the approval tier for an approval

Returns the approval tier that an approval record belongs to. Use it when you have an approval ID and need the tier it is part of.

📄️Get an approval tier by ID

Returns an approval tier, including its approvers, approver groups and escalation settings. Send the tier ID in the id query parameter; the value in the path is not used.