Access Policy Approval Procedure API
Update Access Policy Approval Procedure
Update an existing approval procedure for an access policy.
PUT
/
v2
/
access-policies
/
{access_policy_id}
/
approval-procedures
/
{id}
Update Access Policy Approval Procedure
curl --request PUT \
--url https://public.api.serval.com/v2/access-policies/{access_policy_id}/approval-procedures/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"steps": [
{
"allowSelfApproval": true,
"approvers": [
{
"appOwner": {},
"notify": true
}
],
"customWorkflow": {
"workflowId": "<string>"
},
"approverJustificationMode": "<string>",
"suppressNotifications": true,
"autoApproveSelf": true
}
],
"timeoutSeconds": 123,
"stages": [
{
"steps": [
{
"allowSelfApproval": true,
"approvers": [
{
"appOwner": {},
"notify": true
}
],
"customWorkflow": {
"workflowId": "<string>"
},
"approverJustificationMode": "<string>",
"suppressNotifications": true,
"autoApproveSelf": true
}
]
}
]
}
'import requests
url = "https://public.api.serval.com/v2/access-policies/{access_policy_id}/approval-procedures/{id}"
payload = {
"steps": [
{
"allowSelfApproval": True,
"approvers": [
{
"appOwner": {},
"notify": True
}
],
"customWorkflow": { "workflowId": "<string>" },
"approverJustificationMode": "<string>",
"suppressNotifications": True,
"autoApproveSelf": True
}
],
"timeoutSeconds": 123,
"stages": [{ "steps": [
{
"allowSelfApproval": True,
"approvers": [
{
"appOwner": {},
"notify": True
}
],
"customWorkflow": { "workflowId": "<string>" },
"approverJustificationMode": "<string>",
"suppressNotifications": True,
"autoApproveSelf": True
}
] }]
}
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({
steps: [
{
allowSelfApproval: true,
approvers: [{appOwner: {}, notify: true}],
customWorkflow: {workflowId: '<string>'},
approverJustificationMode: '<string>',
suppressNotifications: true,
autoApproveSelf: true
}
],
timeoutSeconds: 123,
stages: [
{
steps: [
{
allowSelfApproval: true,
approvers: [{appOwner: {}, notify: true}],
customWorkflow: {workflowId: '<string>'},
approverJustificationMode: '<string>',
suppressNotifications: true,
autoApproveSelf: true
}
]
}
]
})
};
fetch('https://public.api.serval.com/v2/access-policies/{access_policy_id}/approval-procedures/{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/{access_policy_id}/approval-procedures/{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([
'steps' => [
[
'allowSelfApproval' => true,
'approvers' => [
[
'appOwner' => [
],
'notify' => true
]
],
'customWorkflow' => [
'workflowId' => '<string>'
],
'approverJustificationMode' => '<string>',
'suppressNotifications' => true,
'autoApproveSelf' => true
]
],
'timeoutSeconds' => 123,
'stages' => [
[
'steps' => [
[
'allowSelfApproval' => true,
'approvers' => [
[
'appOwner' => [
],
'notify' => true
]
],
'customWorkflow' => [
'workflowId' => '<string>'
],
'approverJustificationMode' => '<string>',
'suppressNotifications' => true,
'autoApproveSelf' => true
]
]
]
]
]),
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/{access_policy_id}/approval-procedures/{id}"
payload := strings.NewReader("{\n \"steps\": [\n {\n \"allowSelfApproval\": true,\n \"approvers\": [\n {\n \"appOwner\": {},\n \"notify\": true\n }\n ],\n \"customWorkflow\": {\n \"workflowId\": \"<string>\"\n },\n \"approverJustificationMode\": \"<string>\",\n \"suppressNotifications\": true,\n \"autoApproveSelf\": true\n }\n ],\n \"timeoutSeconds\": 123,\n \"stages\": [\n {\n \"steps\": [\n {\n \"allowSelfApproval\": true,\n \"approvers\": [\n {\n \"appOwner\": {},\n \"notify\": true\n }\n ],\n \"customWorkflow\": {\n \"workflowId\": \"<string>\"\n },\n \"approverJustificationMode\": \"<string>\",\n \"suppressNotifications\": true,\n \"autoApproveSelf\": true\n }\n ]\n }\n ]\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/{access_policy_id}/approval-procedures/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"steps\": [\n {\n \"allowSelfApproval\": true,\n \"approvers\": [\n {\n \"appOwner\": {},\n \"notify\": true\n }\n ],\n \"customWorkflow\": {\n \"workflowId\": \"<string>\"\n },\n \"approverJustificationMode\": \"<string>\",\n \"suppressNotifications\": true,\n \"autoApproveSelf\": true\n }\n ],\n \"timeoutSeconds\": 123,\n \"stages\": [\n {\n \"steps\": [\n {\n \"allowSelfApproval\": true,\n \"approvers\": [\n {\n \"appOwner\": {},\n \"notify\": true\n }\n ],\n \"customWorkflow\": {\n \"workflowId\": \"<string>\"\n },\n \"approverJustificationMode\": \"<string>\",\n \"suppressNotifications\": true,\n \"autoApproveSelf\": true\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://public.api.serval.com/v2/access-policies/{access_policy_id}/approval-procedures/{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 \"steps\": [\n {\n \"allowSelfApproval\": true,\n \"approvers\": [\n {\n \"appOwner\": {},\n \"notify\": true\n }\n ],\n \"customWorkflow\": {\n \"workflowId\": \"<string>\"\n },\n \"approverJustificationMode\": \"<string>\",\n \"suppressNotifications\": true,\n \"autoApproveSelf\": true\n }\n ],\n \"timeoutSeconds\": 123,\n \"stages\": [\n {\n \"steps\": [\n {\n \"allowSelfApproval\": true,\n \"approvers\": [\n {\n \"appOwner\": {},\n \"notify\": true\n }\n ],\n \"customWorkflow\": {\n \"workflowId\": \"<string>\"\n },\n \"approverJustificationMode\": \"<string>\",\n \"suppressNotifications\": true,\n \"autoApproveSelf\": true\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"accessPolicyId": "<string>",
"steps": [
{
"id": "<string>",
"allowSelfApproval": true,
"approvers": [
{
"appOwner": {},
"notify": true
}
],
"customWorkflow": {
"workflowId": "<string>"
},
"approverJustificationMode": "<string>",
"suppressNotifications": true,
"autoApproveSelf": true
}
],
"timeoutSeconds": 123,
"stages": [
{
"steps": [
{
"id": "<string>",
"allowSelfApproval": true,
"approvers": [
{
"appOwner": {},
"notify": true
}
],
"customWorkflow": {
"workflowId": "<string>"
},
"approverJustificationMode": "<string>",
"suppressNotifications": true,
"autoApproveSelf": true
}
]
}
]
}
}Authentication and permissions
Token requirements: User-based token (OAuth) or Organization-scoped API key or Team-scoped API key. Send a bearer access token for one of these identities. The permissions and resource restrictions below also apply.
| Credential | Access requirements |
|---|---|
| Organization-scoped API key | settings:write |
| Team-scoped API key | settings:write |
| User-based token (OAuth) | Supported, subject to permissions |
- Remove the approval gate: An empty steps list removes the gate.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The ID of the access policy.
The ID of the approval procedure.
Body
application/json
The approval steps for the procedure. Required unless stages is set: an empty procedure is rejected, never treated as removal — use DeleteAccessPolicyApprovalProcedure to remove the gate.
Show child attributes
Show child attributes
How long each step waits for a human decision before timing out (in seconds). Omit / zero means "keep the existing value". Non-zero values must be within [5 minutes, 90 days].
Authoritative staged topology. When supplied with steps, steps must be the equivalent flattened compatibility projection.
Show child attributes
Show child attributes
Response
200 - application/json
Success
The updated approval procedure.
Show child attributes
Show child attributes
Was this page helpful?
⌘I
Update Access Policy Approval Procedure
curl --request PUT \
--url https://public.api.serval.com/v2/access-policies/{access_policy_id}/approval-procedures/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"steps": [
{
"allowSelfApproval": true,
"approvers": [
{
"appOwner": {},
"notify": true
}
],
"customWorkflow": {
"workflowId": "<string>"
},
"approverJustificationMode": "<string>",
"suppressNotifications": true,
"autoApproveSelf": true
}
],
"timeoutSeconds": 123,
"stages": [
{
"steps": [
{
"allowSelfApproval": true,
"approvers": [
{
"appOwner": {},
"notify": true
}
],
"customWorkflow": {
"workflowId": "<string>"
},
"approverJustificationMode": "<string>",
"suppressNotifications": true,
"autoApproveSelf": true
}
]
}
]
}
'import requests
url = "https://public.api.serval.com/v2/access-policies/{access_policy_id}/approval-procedures/{id}"
payload = {
"steps": [
{
"allowSelfApproval": True,
"approvers": [
{
"appOwner": {},
"notify": True
}
],
"customWorkflow": { "workflowId": "<string>" },
"approverJustificationMode": "<string>",
"suppressNotifications": True,
"autoApproveSelf": True
}
],
"timeoutSeconds": 123,
"stages": [{ "steps": [
{
"allowSelfApproval": True,
"approvers": [
{
"appOwner": {},
"notify": True
}
],
"customWorkflow": { "workflowId": "<string>" },
"approverJustificationMode": "<string>",
"suppressNotifications": True,
"autoApproveSelf": True
}
] }]
}
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({
steps: [
{
allowSelfApproval: true,
approvers: [{appOwner: {}, notify: true}],
customWorkflow: {workflowId: '<string>'},
approverJustificationMode: '<string>',
suppressNotifications: true,
autoApproveSelf: true
}
],
timeoutSeconds: 123,
stages: [
{
steps: [
{
allowSelfApproval: true,
approvers: [{appOwner: {}, notify: true}],
customWorkflow: {workflowId: '<string>'},
approverJustificationMode: '<string>',
suppressNotifications: true,
autoApproveSelf: true
}
]
}
]
})
};
fetch('https://public.api.serval.com/v2/access-policies/{access_policy_id}/approval-procedures/{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/{access_policy_id}/approval-procedures/{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([
'steps' => [
[
'allowSelfApproval' => true,
'approvers' => [
[
'appOwner' => [
],
'notify' => true
]
],
'customWorkflow' => [
'workflowId' => '<string>'
],
'approverJustificationMode' => '<string>',
'suppressNotifications' => true,
'autoApproveSelf' => true
]
],
'timeoutSeconds' => 123,
'stages' => [
[
'steps' => [
[
'allowSelfApproval' => true,
'approvers' => [
[
'appOwner' => [
],
'notify' => true
]
],
'customWorkflow' => [
'workflowId' => '<string>'
],
'approverJustificationMode' => '<string>',
'suppressNotifications' => true,
'autoApproveSelf' => true
]
]
]
]
]),
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/{access_policy_id}/approval-procedures/{id}"
payload := strings.NewReader("{\n \"steps\": [\n {\n \"allowSelfApproval\": true,\n \"approvers\": [\n {\n \"appOwner\": {},\n \"notify\": true\n }\n ],\n \"customWorkflow\": {\n \"workflowId\": \"<string>\"\n },\n \"approverJustificationMode\": \"<string>\",\n \"suppressNotifications\": true,\n \"autoApproveSelf\": true\n }\n ],\n \"timeoutSeconds\": 123,\n \"stages\": [\n {\n \"steps\": [\n {\n \"allowSelfApproval\": true,\n \"approvers\": [\n {\n \"appOwner\": {},\n \"notify\": true\n }\n ],\n \"customWorkflow\": {\n \"workflowId\": \"<string>\"\n },\n \"approverJustificationMode\": \"<string>\",\n \"suppressNotifications\": true,\n \"autoApproveSelf\": true\n }\n ]\n }\n ]\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/{access_policy_id}/approval-procedures/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"steps\": [\n {\n \"allowSelfApproval\": true,\n \"approvers\": [\n {\n \"appOwner\": {},\n \"notify\": true\n }\n ],\n \"customWorkflow\": {\n \"workflowId\": \"<string>\"\n },\n \"approverJustificationMode\": \"<string>\",\n \"suppressNotifications\": true,\n \"autoApproveSelf\": true\n }\n ],\n \"timeoutSeconds\": 123,\n \"stages\": [\n {\n \"steps\": [\n {\n \"allowSelfApproval\": true,\n \"approvers\": [\n {\n \"appOwner\": {},\n \"notify\": true\n }\n ],\n \"customWorkflow\": {\n \"workflowId\": \"<string>\"\n },\n \"approverJustificationMode\": \"<string>\",\n \"suppressNotifications\": true,\n \"autoApproveSelf\": true\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://public.api.serval.com/v2/access-policies/{access_policy_id}/approval-procedures/{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 \"steps\": [\n {\n \"allowSelfApproval\": true,\n \"approvers\": [\n {\n \"appOwner\": {},\n \"notify\": true\n }\n ],\n \"customWorkflow\": {\n \"workflowId\": \"<string>\"\n },\n \"approverJustificationMode\": \"<string>\",\n \"suppressNotifications\": true,\n \"autoApproveSelf\": true\n }\n ],\n \"timeoutSeconds\": 123,\n \"stages\": [\n {\n \"steps\": [\n {\n \"allowSelfApproval\": true,\n \"approvers\": [\n {\n \"appOwner\": {},\n \"notify\": true\n }\n ],\n \"customWorkflow\": {\n \"workflowId\": \"<string>\"\n },\n \"approverJustificationMode\": \"<string>\",\n \"suppressNotifications\": true,\n \"autoApproveSelf\": true\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"accessPolicyId": "<string>",
"steps": [
{
"id": "<string>",
"allowSelfApproval": true,
"approvers": [
{
"appOwner": {},
"notify": true
}
],
"customWorkflow": {
"workflowId": "<string>"
},
"approverJustificationMode": "<string>",
"suppressNotifications": true,
"autoApproveSelf": true
}
],
"timeoutSeconds": 123,
"stages": [
{
"steps": [
{
"id": "<string>",
"allowSelfApproval": true,
"approvers": [
{
"appOwner": {},
"notify": true
}
],
"customWorkflow": {
"workflowId": "<string>"
},
"approverJustificationMode": "<string>",
"suppressNotifications": true,
"autoApproveSelf": true
}
]
}
]
}
}