---
title: "POST /uar"
method: POST
path: "/uar"
tags: ["uars"]
deprecated: true
---

# POST /uar

`POST /uar`

> **Deprecated.**

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

## Request body

- CreateUARInfo — Information needed to start a user access review.
  - `name` string, 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', 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.
  - `send_reviewer_assignment_notification` boolean, required — A bool representing whether to send a notification to reviewers when they're assigned a new review. Default is False.
  - `deadline` string, date-time, required — The last day for reviewers to complete their access reviews.
  - `time_zone` string, 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_allowed` boolean, required — A bool representing whether to present a warning when a user is the only reviewer for themself. Default is False.
  - `instantly_action_reviews` boolean — A bool representing whether to instantly action changes when reviewers submit their decision. Default is False.
  - `reminder_schedule` integer[]
  - `reminder_include_manager` boolean
  - `uar_scope` UARScope — If set, the access review will only contain resources and groups that match at least one of the filters in scope.
    - `group_visibility` 'STRICT' | 'VIEW_VISIBLE_AND_ASSIGNED' | 'VIEW_ALL' — Specifies what users can see during an Access Review
    - `users` string[] — The access review will only include the following users. If any users are selected, any entity filters will be applied to only the entities that the selected users have access to.
    - `filter_operator` 'ANY' | 'ALL' — Specifies whether entities must match all (AND) or any (OR) of the filters.
    - `entities` string[] — This access review will include resources and groups with ids in the given strings.
    - `apps` string[] — This access review will include items in the specified applications
    - `admins` string[] — This access review will include resources and groups who are owned by one of the owners corresponding to the given IDs.
    - `group_types` GroupTypeEnum[] — This access review will include items of the specified group types
    - `resource_types` ResourceTypeEnum[] — This access review will include items of the specified resource types
    - `include_group_bindings` boolean
    - `tags` TagFilter[] — This access review will include resources and groups who are tagged with one of the given tags.
      - `key` string, required — The key of the tag.
      - `value` string — The value of the tag.
    - `names` string[] — This access review will include resources and groups whose name contains one of the given strings.

## Response `200`

The UAR that was started.

- UAR — A user access review.
  - `uar_id` string, uuid, required — The ID of the UAR.
  - `name` string, 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', 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.
  - `send_reviewer_assignment_notification` boolean, required — A bool representing whether to send a notification to reviewers when they're assigned a new review. Default is False.
  - `deadline` string, date-time, required — The last day for reviewers to complete their access reviews.
  - `time_zone` string, 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_allowed` boolean, required — A bool representing whether to present a warning when a user is the only reviewer for themself. Default is False.
  - `instantly_action_reviews` boolean, required — A bool representing whether to instantly action changes when reviewers submit their decision. Default is False.
  - `uar_scope` UARScope — If set, the access review will only contain resources and groups that match at least one of the filters in scope.
    - `group_visibility` 'STRICT' | 'VIEW_VISIBLE_AND_ASSIGNED' | 'VIEW_ALL' — Specifies what users can see during an Access Review
    - `users` string[] — The access review will only include the following users. If any users are selected, any entity filters will be applied to only the entities that the selected users have access to.
    - `filter_operator` 'ANY' | 'ALL' — Specifies whether entities must match all (AND) or any (OR) of the filters.
    - `entities` string[] — This access review will include resources and groups with ids in the given strings.
    - `apps` string[] — This access review will include items in the specified applications
    - `admins` string[] — This access review will include resources and groups who are owned by one of the owners corresponding to the given IDs.
    - `group_types` GroupTypeEnum[] — This access review will include items of the specified group types
    - `resource_types` ResourceTypeEnum[] — This access review will include items of the specified resource types
    - `include_group_bindings` boolean
    - `tags` TagFilter[] — This access review will include resources and groups who are tagged with one of the given tags.
      - `key` string, required — The key of the tag.
      - `value` string — The value of the tag.
    - `names` string[] — This access review will include resources and groups whose name contains one of the given strings.

---

[API](https://skmtc.net/opal/apis/opal-api.md) · [All operations](https://skmtc.net/opal/apis/opal-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/opal/opal-api/revisions/13b58df96d40/schema)