Get uar

cURL

curl --request GET \
  --url https://api.opal.dev/v1/uar/{uar_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.opal.dev/v1/uar/{uar_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.opal.dev/v1/uar/{uar_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.opal.dev/v1/uar/{uar_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.opal.dev/v1/uar/{uar_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.opal.dev/v1/uar/{uar_id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.opal.dev/v1/uar/{uar_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "uar_id": "f454d283-ca87-4a8a-bdbb-df212eca5353",
  "name": "Monthly UAR (July)",
  "send_reviewer_assignment_notification": false,
  "deadline": "2022-07-14T06:59:59.000Z",
  "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"
    ]
  }
}

GET

uar

{uar_id}

cURL

curl --request GET \
  --url https://api.opal.dev/v1/uar/{uar_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.opal.dev/v1/uar/{uar_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.opal.dev/v1/uar/{uar_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.opal.dev/v1/uar/{uar_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.opal.dev/v1/uar/{uar_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.opal.dev/v1/uar/{uar_id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.opal.dev/v1/uar/{uar_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "uar_id": "f454d283-ca87-4a8a-bdbb-df212eca5353",
  "name": "Monthly UAR (July)",
  "send_reviewer_assignment_notification": false,
  "deadline": "2022-07-14T06:59:59.000Z",
  "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"
    ]
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

uar_id

string<uuid>

required

The ID of the UAR.

Response

200 - application/json

The UAR that was requested.

A user access review.

uar_id

string<uuid>

required

The ID of the UAR.

Example:

"f454d283-ca87-4a8a-bdbb-df212eca5353"

name

string

required

The name of the UAR.

Example:

"Monthly UAR (July)"

reviewer_assignment_policy

enum<string>

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.

Available options:

MANUALLY,

BY_OWNING_TEAM_ADMIN,

BY_OWNING_TEAM_ADMIN_ALL,

BY_MANAGER,

BY_APPROVERS,

BY_APPROVERS_ALL

Example:

"MANUALLY"

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.

Example:

false

deadline

string<date-time>

required

The last day for reviewers to complete their access reviews.

Example:

"2022-07-14T06:59:59.000Z"

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.

Example:

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

Example:

false

instantly_action_reviews

boolean

required

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

Example:

false

uar_scope

object

If set, the access review will only contain resources and groups that match at least one of the filters in scope.

Show child attributes

Example:

{
  "filter_operator": "ANY",
  "users": ["userd283-ca87-4a8a-bdbb-df212eca5353"],
  "include_group_bindings": true,
  "tags": [
    {
      "key": "uar_scope",
      "value": "high_priority"
    }
  ],
  "names": ["demo", "api"],
  "admins": [
    "f454d283-ca87-4a8a-bdbb-df212eca5353",
    "8763d283-ca87-4a8a-bdbb-df212ecab139"
  ],
  "resource_types": ["GCP_CLOUD_SQL_POSTGRES_INSTANCE"],
  "group_types": ["AWS_SSO_GROUP"],
  "apps": [
    "pas2d283-ca87-4a8a-bdbb-df212eca5353",
    "apss2d283-ca87-4a8a-bdbb-df212eca5353"
  ],
  "entities": [
    "f454d283-as87-4a8a-bdbb-df212eca5353",
    "f454d283-as87-4a8a-bdbb-df212eca5329"
  ]
}

Last modified on July 10, 2026

Post uar Get delegations

⌘I

API Concepts

SDKs

Opal API

Authorizations

Path Parameters

Response