Update Access Policy
Update an existing access policy.
curl --request PUT \
--url https://public.api.serval.com/v2/access-policies/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"maxAccessMinutes": 123,
"requireBusinessJustification": true,
"recommendedAccessMinutes": 123,
"requireOnBehalfOfConfirmation": true,
"scopedId": "<string>"
}
'import requests
url = "https://public.api.serval.com/v2/access-policies/{id}"
payload = {
"name": "<string>",
"description": "<string>",
"maxAccessMinutes": 123,
"requireBusinessJustification": True,
"recommendedAccessMinutes": 123,
"requireOnBehalfOfConfirmation": True,
"scopedId": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
maxAccessMinutes: 123,
requireBusinessJustification: true,
recommendedAccessMinutes: 123,
requireOnBehalfOfConfirmation: true,
scopedId: '<string>'
})
};
fetch('https://public.api.serval.com/v2/access-policies/{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://public.api.serval.com/v2/access-policies/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'maxAccessMinutes' => 123,
'requireBusinessJustification' => true,
'recommendedAccessMinutes' => 123,
'requireOnBehalfOfConfirmation' => true,
'scopedId' => '<string>'
]),
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://public.api.serval.com/v2/access-policies/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"maxAccessMinutes\": 123,\n \"requireBusinessJustification\": true,\n \"recommendedAccessMinutes\": 123,\n \"requireOnBehalfOfConfirmation\": true,\n \"scopedId\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://public.api.serval.com/v2/access-policies/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"maxAccessMinutes\": 123,\n \"requireBusinessJustification\": true,\n \"recommendedAccessMinutes\": 123,\n \"requireOnBehalfOfConfirmation\": true,\n \"scopedId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://public.api.serval.com/v2/access-policies/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"maxAccessMinutes\": 123,\n \"requireBusinessJustification\": true,\n \"recommendedAccessMinutes\": 123,\n \"requireOnBehalfOfConfirmation\": true,\n \"scopedId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"teamId": "<string>",
"name": "<string>",
"description": "<string>",
"maxAccessMinutes": 123,
"requireBusinessJustification": true,
"recommendedAccessMinutes": 123,
"requireOnBehalfOfConfirmation": true,
"scopedId": "<string>"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The ID of the access policy.
Body
The name of the access policy.
A description of the access policy.
The maximum number of minutes that access can be granted for.
Whether a business justification is required when requesting access. Omit to leave unchanged.
The recommended duration in minutes for access requests (optional).
Whether requests made on behalf of others require the target user's confirmation. Omit to leave unchanged.
Rekeys the policy's stable identity (apo_ + 22 base62 chars). Omit to leave unchanged. Must be unique within the team. The team-default policy cannot be rekeyed, and reserved sentinel values are rejected.
Response
Success
The updated access policy.
Show child attributes
Show child attributes
Was this page helpful?
curl --request PUT \
--url https://public.api.serval.com/v2/access-policies/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"maxAccessMinutes": 123,
"requireBusinessJustification": true,
"recommendedAccessMinutes": 123,
"requireOnBehalfOfConfirmation": true,
"scopedId": "<string>"
}
'import requests
url = "https://public.api.serval.com/v2/access-policies/{id}"
payload = {
"name": "<string>",
"description": "<string>",
"maxAccessMinutes": 123,
"requireBusinessJustification": True,
"recommendedAccessMinutes": 123,
"requireOnBehalfOfConfirmation": True,
"scopedId": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
maxAccessMinutes: 123,
requireBusinessJustification: true,
recommendedAccessMinutes: 123,
requireOnBehalfOfConfirmation: true,
scopedId: '<string>'
})
};
fetch('https://public.api.serval.com/v2/access-policies/{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://public.api.serval.com/v2/access-policies/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'maxAccessMinutes' => 123,
'requireBusinessJustification' => true,
'recommendedAccessMinutes' => 123,
'requireOnBehalfOfConfirmation' => true,
'scopedId' => '<string>'
]),
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://public.api.serval.com/v2/access-policies/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"maxAccessMinutes\": 123,\n \"requireBusinessJustification\": true,\n \"recommendedAccessMinutes\": 123,\n \"requireOnBehalfOfConfirmation\": true,\n \"scopedId\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://public.api.serval.com/v2/access-policies/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"maxAccessMinutes\": 123,\n \"requireBusinessJustification\": true,\n \"recommendedAccessMinutes\": 123,\n \"requireOnBehalfOfConfirmation\": true,\n \"scopedId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://public.api.serval.com/v2/access-policies/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"maxAccessMinutes\": 123,\n \"requireBusinessJustification\": true,\n \"recommendedAccessMinutes\": 123,\n \"requireOnBehalfOfConfirmation\": true,\n \"scopedId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"teamId": "<string>",
"name": "<string>",
"description": "<string>",
"maxAccessMinutes": 123,
"requireBusinessJustification": true,
"recommendedAccessMinutes": 123,
"requireOnBehalfOfConfirmation": true,
"scopedId": "<string>"
}
}
