Cancel an access review.

POST

/api/admin/compliance/access-reviews/{id}/cancel

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/admin/compliance/access-reviews/example/cancel \
  --header 'Authorization: Bearer <token>'

Cancels an open review none of whose revocations is being applied, was applied or started.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

id

required

string

Access review id.

Responses

200

The cancelled review.

Media type application/json

object

review_id

required

string

name

required

string

description

string | null

scope

required

string

Allowed values: all_users role organization inactive_users

scope_value

string | null

inactive_days

integer | null

status

required

string

Allowed values: pending in_progress completed cancelled

reviewer_id

string | null

created_by

string | null

completed_by

string | null

progress

required

object

total_items

required

integer

reviewed_items

required

integer

approved_items

required

integer

revoked_items

required

integer

completion_percent

required

integer

created_at

required

string | null format: date-time

started_at

string | null format: date-time

completed_at

string | null format: date-time

due_date

string | null format: date-time

overdue

required

boolean

Example

{
  "scope": "all_users",
  "status": "pending"
}

401

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

404

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

409

The review is not open, or revocations were applied.

500

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}