Skip to main content
POST
Cancel request

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required

The ID of the request to cancel.

Body

application/json
acting_user_id
string<uuid>

Cancel as this Opal user instead of the caller. Only for service users an admin has allowed to act for users, in organizations with the feature enabled. The user must be active in the identity provider and be an Opal admin or the request's requester, target or initiated_by user. Unknown body fields are ignored, so a misspelled field cancels as the caller.

Response

The canceled request.

Request Object

Description

The Request object is used to represent a request.

Usage Example

Returned from the GET Requests endpoint.

id
string<uuid>
required

The unique identifier of the request.

Example:

"7c86c85d-0651-43e2-a748-d69d658418e8"

created_at
string<date-time>
required

The date and time the request was created.

Example:

"2021-01-06T20:00:00.000Z"

updated_at
string<date-time>
required

The date and time the request was last updated.

Example:

"2021-01-06T20:00:00.000Z"

requester_id
string<uuid>
required

The unique identifier of the user who created the request.

Example:

"7c86c85d-0651-43e2-a748-d69d658418e8"

status
enum<string>
required

The status of the request.

Available options:
PENDING,
APPROVED,
DENIED,
CANCELED
Example:

"pending"

reason
string
required

The reason for the request.

Example:

"I need access to the AWS account."

initiated_by_user_id
string<uuid>

The unique identifier of the user the caller asserted asked for this access. Unverified - Opal records the claim as given. Absent unless the caller supplied it.

Example:

"7c86c85d-0651-43e2-a748-d69d658418e8"

target_user_id
string<uuid>

The unique identifier of the user who is the target of the request.

Example:

"7c86c85d-0651-43e2-a748-d69d658418e8"

target_group_id
string<uuid>

The unique identifier of the group who is the target of the request.

Example:

"7c86c85d-0651-43e2-a748-d69d658418e8"

source
enum<string>

The channel that created the request. Omitted when the source was not recorded. MCP counts only OAuth sessions. An agent using an API token or a person's credentials is counted as API, CLI, or WEB.

Available options:
WEB,
SLACK,
MICROSOFT_TEAMS,
CLI,
API,
MCP,
ACCESS_REVIEW
duration_minutes
integer

The duration of the request in minutes.

Example:

120

requested_items_list
object[]

The list of targets for the request.

custom_fields_responses
object[]

The responses given to the custom fields associated to the request

stages
object
deprecated

The stages configuration for this request

reviewer_stages

The configured reviewer stages for every item in this request, or an error message if reviewers could not be loaded