Skip to content
Authrim

Create a compliance 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-31T00:00:00.000Z" }'

Creates an access review for a tenant scope such as all users, a role, an organization, or inactive users. Returns the created review metadata and due date.

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
string
due_date
string format: date-time
key
additional properties
Example 
{
  "name": "Quarterly privileged access review",
  "description": "Review all tenant admins.",
  "scope": "role",
  "scope_value": "admin",
  "due_date": "2026-07-31T00:00:00.000Z"
}

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
scope
required
string
Allowed values: all_users role organization inactive_users
scope_value
string | null
status
required
string
Allowed values: pending
reviewer_id
required
string
total_items
required
integer
created_at
required
string | null format: date-time
due_date
required
string | null format: date-time
key
additional properties
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"
}