Create Access Review

Create a new access review campaign.

The review's initial status depends on whether apps are provided and whether a target_launch_date is set:

  • 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.
  • With a target_launch_date: the review is held for that date in SCHEDULED, or SCHEDULED_IN_PREPARATION while its apps are snapshotted, and returns to SCHEDULED once snapshotting completes. A daily job launches it on the date, moving it to IN_PROGRESS.

A recurrence_config or recurrence_days_frequency takes effect only alongside a target_launch_date; sent without one it is rejected.

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.

Date the review is scheduled to launch on, as an ISO 8601 datetime; the time of day is ignored. The review is held until then and launches automatically once its apps are ready. Must not be in the past, and must not be after deadline_at. Required to make a recurrence cadence take effect.

RecurrenceConfigInput | null

Recurrence configuration. Mutually exclusive with recurrence_days_frequency, and only accepted together with target_launch_date.

Recurrence frequency in days. Mutually exclusive with recurrence_config, and only accepted together with target_launch_date.

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