Create Access Review

Create a new access review campaign.

The review's initial status depends on whether apps are provided:

  • With apps: the review starts in IN_PREPARATION while account and entitlement snapshots are taken. Status automatically transitions to IN_PROGRESS once snapshotting completes.
  • Without apps: the review is created directly in IN_PROGRESS.

Poll GET /access_reviews/{id} to observe the status transition. To add apps after creation, use POST /access_reviews/{id}/apps (allowed on any status except COMPLETED).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length between 1 and 255

Name of the access review campaign.

date-time
required

Deadline by which reviewers must complete their reviews. ISO 8601 datetime (e.g. '2026-05-01T00:00:00Z').

UUID of the user to set as the review owner. Defaults to the authenticated user if not provided.

Scheduled launch date for the review. ISO 8601 datetime.

recurrence_config

Recurrence configuration. Mutually exclusive with recurrence_days_frequency.

Recurrence frequency in days. Mutually exclusive with recurrence_config.

apps
array of objects
length ≤ 200

List of domain apps to include in this review. Capped at 200 entries per the Access Review scale limits (technically-supported tier).

Apps
Responses

400

Validation error — the request violated a business rule (e.g. duplicate review name, deadline in the past, review not in the required status for this operation).

403

Forbidden — the caller lacks permission to create or manage access reviews. Requires the Access Review Administrator or App Admin role on the domain.

404

Not found — the access reviews API is not enabled for this domain, or the referenced review / app does not exist.

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json