cURL
curl --request POST \
--url https://api.opal.dev/v1/uar \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"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,
"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"
]
}
}
'import requests
url = "https://api.opal.dev/v1/uar"
payload = {
"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,
"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"]
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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,
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']
}
})
};
fetch('https://api.opal.dev/v1/uar', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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,
'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'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.opal.dev/v1/uar"
payload := strings.NewReader("{\n \"name\": \"Monthly UAR (July)\",\n \"send_reviewer_assignment_notification\": false,\n \"deadline\": \"2022-07-14T06:59:59.000Z\",\n \"time_zone\": \"America/Los_Angeles\",\n \"self_review_allowed\": false,\n \"reminder_schedule\": [\n 7,\n 3,\n 1,\n 0\n ],\n \"reminder_include_manager\": true,\n \"uar_scope\": {\n \"group_visibility\": \"STRICT\",\n \"tags\": [\n {\n \"key\": \"uar_scope\",\n \"value\": \"high_priority\"\n }\n ],\n \"names\": [\n \"demo\",\n \"api\"\n ],\n \"admins\": [\n \"f454d283-ca87-4a8a-bdbb-df212eca5353\",\n \"8763d283-ca87-4a8a-bdbb-df212ecab139\"\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.opal.dev/v1/uar")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Monthly UAR (July)\",\n \"send_reviewer_assignment_notification\": false,\n \"deadline\": \"2022-07-14T06:59:59.000Z\",\n \"time_zone\": \"America/Los_Angeles\",\n \"self_review_allowed\": false,\n \"reminder_schedule\": [\n 7,\n 3,\n 1,\n 0\n ],\n \"reminder_include_manager\": true,\n \"uar_scope\": {\n \"group_visibility\": \"STRICT\",\n \"tags\": [\n {\n \"key\": \"uar_scope\",\n \"value\": \"high_priority\"\n }\n ],\n \"names\": [\n \"demo\",\n \"api\"\n ],\n \"admins\": [\n \"f454d283-ca87-4a8a-bdbb-df212eca5353\",\n \"8763d283-ca87-4a8a-bdbb-df212ecab139\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.opal.dev/v1/uar")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Monthly UAR (July)\",\n \"send_reviewer_assignment_notification\": false,\n \"deadline\": \"2022-07-14T06:59:59.000Z\",\n \"time_zone\": \"America/Los_Angeles\",\n \"self_review_allowed\": false,\n \"reminder_schedule\": [\n 7,\n 3,\n 1,\n 0\n ],\n \"reminder_include_manager\": true,\n \"uar_scope\": {\n \"group_visibility\": \"STRICT\",\n \"tags\": [\n {\n \"key\": \"uar_scope\",\n \"value\": \"high_priority\"\n }\n ],\n \"names\": [\n \"demo\",\n \"api\"\n ],\n \"admins\": [\n \"f454d283-ca87-4a8a-bdbb-df212eca5353\",\n \"8763d283-ca87-4a8a-bdbb-df212ecab139\"\n ]\n }\n}"
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"
]
}
}Post uar
deprecated
Starts a User Access Review. Deprecated in favor of POST /campaigns.
POST
/
uar
cURL
curl --request POST \
--url https://api.opal.dev/v1/uar \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"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,
"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"
]
}
}
'import requests
url = "https://api.opal.dev/v1/uar"
payload = {
"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,
"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"]
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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,
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']
}
})
};
fetch('https://api.opal.dev/v1/uar', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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,
'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'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.opal.dev/v1/uar"
payload := strings.NewReader("{\n \"name\": \"Monthly UAR (July)\",\n \"send_reviewer_assignment_notification\": false,\n \"deadline\": \"2022-07-14T06:59:59.000Z\",\n \"time_zone\": \"America/Los_Angeles\",\n \"self_review_allowed\": false,\n \"reminder_schedule\": [\n 7,\n 3,\n 1,\n 0\n ],\n \"reminder_include_manager\": true,\n \"uar_scope\": {\n \"group_visibility\": \"STRICT\",\n \"tags\": [\n {\n \"key\": \"uar_scope\",\n \"value\": \"high_priority\"\n }\n ],\n \"names\": [\n \"demo\",\n \"api\"\n ],\n \"admins\": [\n \"f454d283-ca87-4a8a-bdbb-df212eca5353\",\n \"8763d283-ca87-4a8a-bdbb-df212ecab139\"\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.opal.dev/v1/uar")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Monthly UAR (July)\",\n \"send_reviewer_assignment_notification\": false,\n \"deadline\": \"2022-07-14T06:59:59.000Z\",\n \"time_zone\": \"America/Los_Angeles\",\n \"self_review_allowed\": false,\n \"reminder_schedule\": [\n 7,\n 3,\n 1,\n 0\n ],\n \"reminder_include_manager\": true,\n \"uar_scope\": {\n \"group_visibility\": \"STRICT\",\n \"tags\": [\n {\n \"key\": \"uar_scope\",\n \"value\": \"high_priority\"\n }\n ],\n \"names\": [\n \"demo\",\n \"api\"\n ],\n \"admins\": [\n \"f454d283-ca87-4a8a-bdbb-df212eca5353\",\n \"8763d283-ca87-4a8a-bdbb-df212ecab139\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.opal.dev/v1/uar")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Monthly UAR (July)\",\n \"send_reviewer_assignment_notification\": false,\n \"deadline\": \"2022-07-14T06:59:59.000Z\",\n \"time_zone\": \"America/Los_Angeles\",\n \"self_review_allowed\": false,\n \"reminder_schedule\": [\n 7,\n 3,\n 1,\n 0\n ],\n \"reminder_include_manager\": true,\n \"uar_scope\": {\n \"group_visibility\": \"STRICT\",\n \"tags\": [\n {\n \"key\": \"uar_scope\",\n \"value\": \"high_priority\"\n }\n ],\n \"names\": [\n \"demo\",\n \"api\"\n ],\n \"admins\": [\n \"f454d283-ca87-4a8a-bdbb-df212eca5353\",\n \"8763d283-ca87-4a8a-bdbb-df212ecab139\"\n ]\n }\n}"
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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
The settings of the UAR.
Information needed to start a user access review.
The name of the UAR.
Example:
"Monthly UAR (July)"
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.
Available options:
MANUALLY, BY_OWNING_TEAM_ADMIN, BY_OWNING_TEAM_ADMIN_ALL, BY_MANAGER, BY_APPROVERS, BY_APPROVERS_ALL, BY_SELF Example:
"MANUALLY"
A bool representing whether to send a notification to reviewers when they're assigned a new review. Default is False.
Example:
false
The last day for reviewers to complete their access reviews.
Example:
"2022-07-14T06:59:59.000Z"
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"
A bool representing whether to present a warning when a user is the only reviewer for themself. Default is False.
Example:
false
A bool representing whether to instantly action changes when reviewers submit their decision. Default is False.
Example:
false
Example:
false
If set, the access review will only contain resources and groups that match at least one of the filters in scope.
Show child attributes
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" ] }
Response
200 - application/json
The UAR that was started.
A user access review.
The ID of the UAR.
Example:
"f454d283-ca87-4a8a-bdbb-df212eca5353"
The name of the UAR.
Example:
"Monthly UAR (July)"
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.
Available options:
MANUALLY, BY_OWNING_TEAM_ADMIN, BY_OWNING_TEAM_ADMIN_ALL, BY_MANAGER, BY_APPROVERS, BY_APPROVERS_ALL, BY_SELF Example:
"MANUALLY"
A bool representing whether to send a notification to reviewers when they're assigned a new review. Default is False.
Example:
false
The last day for reviewers to complete their access reviews.
Example:
"2022-07-14T06:59:59.000Z"
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"
A bool representing whether to present a warning when a user is the only reviewer for themself. Default is False.
Example:
false
A bool representing whether to instantly action changes when reviewers submit their decision. Default is False.
Example:
false
If set, the access review will only contain resources and groups that match at least one of the filters in scope.
Show child attributes
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" ] }
Was this page helpful?