uars

POST /uar

Changed on Nov 4, 2026

Starts a User Access Review. Deprecated in favor of POST /campaigns.

Request

Base URL
https://api.opal.dev/v1
Auth
HTTP bearer

Request body

namestring required

The name of the UAR.

reviewer_assignment_policy'MANUALLY' | 'BY_OWNING_TEAM_ADMIN' | 'BY_OWNING_TEAM_ADMIN_ALL' | 'BY_MANAGER' | 'BY_APPROVERS' | 'BY_APPROVERS_ALL' | 'BY_SELF' required

A policy for auto-assigning reviewers. If auto-assignment is on, specific assignments can still be manually adjusted after the access review is started. Default is Manually. BY_OWNING_TEAM_ADMIN assigns reviews to resource admins in round-robin fashion. BY_OWNING_TEAM_ADMIN_ALL assigns reviews to all resource admins. BY_APPROVERS assigns reviews to resource approvers in round-robin fashion. BY_APPROVERS_ALL assigns reviews to all resource approvers. BY_SELF assigns each item to the reviewed principal themselves.

send_reviewer_assignment_notificationboolean required

A bool representing whether to send a notification to reviewers when they're assigned a new review. Default is False.

deadlinestring date-time required

The last day for reviewers to complete their access reviews.

time_zonestring required

The time zone name (as defined by the IANA Time Zone database) used in the access review deadline and exported audit report. Default is America/Los_Angeles.

self_review_allowedboolean required

A bool representing whether to present a warning when a user is the only reviewer for themself. Default is False.

instantly_action_reviewsboolean

A bool representing whether to instantly action changes when reviewers submit their decision. Default is False.

reminder_scheduleinteger[]

reminder_include_managerboolean

Example request

{
  "name": "Monthly UAR (July)",
  "send_reviewer_assignment_notification": false,
  "deadline": "2022-07-14T06:59:59Z",
  "time_zone": "America/Los_Angeles",
  "self_review_allowed": false,
  "reminder_schedule": [
    7,
    3,
    1,
    0
  ],
  "reminder_include_manager": true,
  "uar_scope": {
    "group_visibility": "STRICT",
    "tags": [
      {
        "key": "uar_scope",
        "value": "high_priority"
      }
    ],
    "names": [
      "demo",
      "api"
    ],
    "admins": [
      "f454d283-ca87-4a8a-bdbb-df212eca5353",
      "8763d283-ca87-4a8a-bdbb-df212ecab139"
    ]
  }
}

Response

The UAR that was started.

uar_idstring uuid required

The ID of the UAR.

namestring required

The name of the UAR.

reviewer_assignment_policy'MANUALLY' | 'BY_OWNING_TEAM_ADMIN' | 'BY_OWNING_TEAM_ADMIN_ALL' | 'BY_MANAGER' | 'BY_APPROVERS' | 'BY_APPROVERS_ALL' | 'BY_SELF' required

A policy for auto-assigning reviewers. If auto-assignment is on, specific assignments can still be manually adjusted after the access review is started. Default is Manually. BY_OWNING_TEAM_ADMIN assigns reviews to resource admins in round-robin fashion. BY_OWNING_TEAM_ADMIN_ALL assigns reviews to all resource admins. BY_APPROVERS assigns reviews to resource approvers in round-robin fashion. BY_APPROVERS_ALL assigns reviews to all resource approvers. BY_SELF assigns each item to the reviewed principal themselves.

send_reviewer_assignment_notificationboolean required

A bool representing whether to send a notification to reviewers when they're assigned a new review. Default is False.

deadlinestring date-time required

The last day for reviewers to complete their access reviews.

time_zonestring required

The time zone name (as defined by the IANA Time Zone database) used in the access review deadline and exported audit report. Default is America/Los_Angeles.

self_review_allowedboolean required

A bool representing whether to present a warning when a user is the only reviewer for themself. Default is False.

instantly_action_reviewsboolean required

A bool representing whether to instantly action changes when reviewers submit their decision. Default is False.

Example response

{
  "uar_id": "f454d283-ca87-4a8a-bdbb-df212eca5353",
  "name": "Monthly UAR (July)",
  "send_reviewer_assignment_notification": false,
  "deadline": "2022-07-14T06:59:59Z",
  "time_zone": "America/Los_Angeles",
  "self_review_allowed": false,
  "uar_scope": {
    "tags": [
      {
        "key": "uar_scope",
        "value": "high_priority"
      }
    ],
    "names": [
      "demo",
      "api"
    ],
    "admins": [
      "f454d283-ca87-4a8a-bdbb-df212eca5353",
      "8763d283-ca87-4a8a-bdbb-df212ecab139"
    ]
  }
}

Changes

Nov 4, 2026e7877ea96eab Revision changes
- warning
  added the new ACTIVECAMPAIGN_GROUP enum value to the // response property for the response status
- warning
  added the new ASANA_WORKSPACE_GUEST enum value to the // response property for the response status
- info
  added the new ACTIVECAMPAIGN_GROUP enum value to the request property //
- info
  added the new ASANA_WORKSPACE_GUEST enum value to the request property //
Oct 28, 2026c54b1c07fcdb Revision changes
- warning
  added the new ONELOGIN_APP enum value to the // response property for the response status
- warning
  added the new ONELOGIN_GROUP enum value to the // response property for the response status
- warning
  added the new ONELOGIN_ROLE enum value to the // response property for the response status
- info
  added the new ONELOGIN_APP enum value to the request property //
- info
  added the new ONELOGIN_GROUP enum value to the request property //
- info
  added the new ONELOGIN_ROLE enum value to the request property //

Operation history (21 revisions)