Skip to content
Authrim

Start an access review.

POST
/api/admin/compliance/access-reviews
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/compliance/access-reviews \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "Quarterly privileged access review", "description": "Review all tenant admins.", "scope": "role", "scope_value": "admin", "due_date": "2026-07-31" }'

Starts a review of who has some access, taking its items from every store the tenant’s accounts live in: users with a role (role), members of an organization (organization), all active registered users (all_users), or those not signed in for inactive_days (default 90; inactive_users, by the sign-in their sessions recorded). A review over 1000 items is refused (access_review_too_large), and an inactive-user review that needs more than 5000 sign-in lookups too (access_review_scan_limit); narrow the scope.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
name
required
string
<= 200 characters
description
string
<= 1000 characters
scope
required
string
Allowed values: all_users role organization inactive_users
scope_value

The role id (role) or organization id (organization); required for them.

string
due_date

A date (the end of that day, UTC) or a date-time.

string
inactive_days

For inactive_users; default 90.

integer
>= 1 <= 3650
key
additional properties
Example 
{
  "name": "Quarterly privileged access review",
  "description": "Review all tenant admins.",
  "scope": "role",
  "scope_value": "admin",
  "due_date": "2026-07-31"
}

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Compliance access review creation response.

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"
}

400

Section titled “400 ”

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"
}

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"
}

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"
}