Skip to content
Authrim

Complete an access review.

POST
/api/admin/compliance/access-reviews/{id}/complete
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/compliance/access-reviews/example/complete \
  --header 'Authorization: Bearer <token>'

Applies the revocations (removing the role assignment or membership, or suspending the account, as the Admin API does and with the permission it requires: roles write for roles and memberships, users suspend for accounts; up to 100 per request, those not tried yet first) and completes the review once every item is decided and every revocation is applied. Each item is claimed while it is applied, so its decision cannot change and the review cannot be cancelled meanwhile. Failed revocations are retried by completing again. Undecided items: 409 access_review_undecided_items.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Access review id.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

What was applied, and whether the review completed.

Media type application/json
object
completed
required
boolean
applied
required
integer
failed
required
integer
remaining
required

Revocations still to apply (failed ones included); complete again to continue.

integer
review
required
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 
{
  "review": {
    "scope": "all_users",
    "status": "pending"
  }
}

401

Section titled “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

Section titled “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

Section titled “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

Section titled “409 ”

The review is not open, or has undecided items.

500

Section titled “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"
}