PingAuthorize API Reference

Update Policy (ID)

PUT {{apiPath}}/v2/policy-manager/policies/{{policyId}}?branch={{branchId}}

The PUT /v2/policy-manager/policies/{{policyId}} operation updates the policy specified by the id in the request URL. The request must provide either a branch ID or a snapshot ID in the request URL.

Prerequisites

Query parameters
Query parameter Description

branch

Branch ID or name

force

If true, ensures that the policy has no parent policy sets after the request completes

snapshot

Snapshot ID

Request Model

For property descriptions, refer to Authorization policy data model.

Property Type Required?

version

String

Optional

name

String

Required

description

String

Required

shared

Boolean

Optional

disabled

Boolean

Optional

combiningAlgorithm

CombiningAlgorithm

Required

children

Collection of RuleNodeRepresentation

Optional

repetitionSettings

RepetitionSettings

Required

condition

Condition object

Required

statements

Collection of StatementNodeRepresentation

Optional

targets

Collection of TargetNodeRepresentation

Optional

Headers

Content-Type      application/json

x-user-id      {{userId}}

Body

raw ( application/json )

{
  "id": "{{policyId}}",
  "type": "Policy",
  "name": "Test Token Authorization",
  "version": "{{versionId}}",
  "description": "Token authorization policy update.",
  "shared": false,
  "disabled": false,
  "combiningAlgorithm": {
    "algorithm": "DenyOverrides"
  }
}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff --request PUT '{{apiPath}}/v2/policy-manager/policies/{{policyId}}?branch={{branchId}}' \
--header 'x-user-id: {{userId}}' \
--header 'Content-Type: application/json' \
--data '{
  "id": "{{policyId}}",
  "type": "Policy",
  "name": "Test Token Authorization",
  "version": "{{versionId}}",
  "description": "Token authorization policy update.",
  "shared": false,
  "disabled": false,
  "combiningAlgorithm": {
    "algorithm": "DenyOverrides"
  }
}'
var options = new RestClientOptions("{{apiPath}}/v2/policy-manager/policies/{{policyId}}?branch={{branchId}}")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Put);
request.AddHeader("x-user-id", "{{userId}}");
request.AddHeader("Content-Type", "application/json");
var body = @"{" + "\n" +
@"  ""id"": ""{{policyId}}""," + "\n" +
@"  ""type"": ""Policy""," + "\n" +
@"  ""name"": ""Test Token Authorization""," + "\n" +
@"  ""version"": ""{{versionId}}""," + "\n" +
@"  ""description"": ""Token authorization policy update.""," + "\n" +
@"  ""shared"": false," + "\n" +
@"  ""disabled"": false," + "\n" +
@"  ""combiningAlgorithm"": {" + "\n" +
@"    ""algorithm"": ""DenyOverrides""" + "\n" +
@"  }" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
package main

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

func main() {

  url := "{{apiPath}}/v2/policy-manager/policies/{{policyId}}?branch={{branchId}}"
  method := "PUT"

  payload := strings.NewReader(`{
  "id": "{{policyId}}",
  "type": "Policy",
  "name": "Test Token Authorization",
  "version": "{{versionId}}",
  "description": "Token authorization policy update.",
  "shared": false,
  "disabled": false,
  "combiningAlgorithm": {
    "algorithm": "DenyOverrides"
  }
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("x-user-id", "{{userId}}")
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := io.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}
PUT /v2/policy-manager/policies/{{policyId}}?branch={{branchId}} HTTP/1.1
Host: {{apiPath}}
x-user-id: {{userId}}
Content-Type: application/json

{
  "id": "{{policyId}}",
  "type": "Policy",
  "name": "Test Token Authorization",
  "version": "{{versionId}}",
  "description": "Token authorization policy update.",
  "shared": false,
  "disabled": false,
  "combiningAlgorithm": {
    "algorithm": "DenyOverrides"
  }
}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n  \"id\": \"{{policyId}}\",\n  \"type\": \"Policy\",\n  \"name\": \"Test Token Authorization\",\n  \"version\": \"{{versionId}}\",\n  \"description\": \"Token authorization policy update.\",\n  \"shared\": false,\n  \"disabled\": false,\n  \"combiningAlgorithm\": {\n    \"algorithm\": \"DenyOverrides\"\n  }\n}");
Request request = new Request.Builder()
  .url("{{apiPath}}/v2/policy-manager/policies/{{policyId}}?branch={{branchId}}")
  .method("PUT", body)
  .addHeader("x-user-id", "{{userId}}")
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{apiPath}}/v2/policy-manager/policies/{{policyId}}?branch={{branchId}}",
  "method": "PUT",
  "timeout": 0,
  "headers": {
    "x-user-id": "{{userId}}",
    "Content-Type": "application/json"
  },
  "data": JSON.stringify({
    "id": "{{policyId}}",
    "type": "Policy",
    "name": "Test Token Authorization",
    "version": "{{versionId}}",
    "description": "Token authorization policy update.",
    "shared": false,
    "disabled": false,
    "combiningAlgorithm": {
      "algorithm": "DenyOverrides"
    }
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'PUT',
  'url': '{{apiPath}}/v2/policy-manager/policies/{{policyId}}?branch={{branchId}}',
  'headers': {
    'x-user-id': '{{userId}}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "id": "{{policyId}}",
    "type": "Policy",
    "name": "Test Token Authorization",
    "version": "{{versionId}}",
    "description": "Token authorization policy update.",
    "shared": false,
    "disabled": false,
    "combiningAlgorithm": {
      "algorithm": "DenyOverrides"
    }
  })

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
import requests
import json

url = "{{apiPath}}/v2/policy-manager/policies/{{policyId}}?branch={{branchId}}"

payload = json.dumps({
  "id": "{{policyId}}",
  "type": "Policy",
  "name": "Test Token Authorization",
  "version": "{{versionId}}",
  "description": "Token authorization policy update.",
  "shared": False,
  "disabled": False,
  "combiningAlgorithm": {
    "algorithm": "DenyOverrides"
  }
})
headers = {
  'x-user-id': '{{userId}}',
  'Content-Type': 'application/json'
}

response = requests.request("PUT", url, headers=headers, data=payload)

print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/v2/policy-manager/policies/{{policyId}}?branch={{branchId}}');
$request->setMethod(HTTP_Request2::METHOD_PUT);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'x-user-id' => '{{userId}}',
  'Content-Type' => 'application/json'
));
$request->setBody('{\n  "id": "{{policyId}}",\n  "type": "Policy",\n  "name": "Test Token Authorization",\n  "version": "{{versionId}}",\n  "description": "Token authorization policy update.",\n  "shared": false,\n  "disabled": false,\n  "combiningAlgorithm": {\n    "algorithm": "DenyOverrides"\n  }\n}');
try {
  $response = $request->send();
  if ($response->getStatus() == 200) {
    echo $response->getBody();
  }
  else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
  }
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}
require "uri"
require "json"
require "net/http"

url = URI("{{apiPath}}/v2/policy-manager/policies/{{policyId}}?branch={{branchId}}")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Put.new(url)
request["x-user-id"] = "{{userId}}"
request["Content-Type"] = "application/json"
request.body = JSON.dump({
  "id": "{{policyId}}",
  "type": "Policy",
  "name": "Test Token Authorization",
  "version": "{{versionId}}",
  "description": "Token authorization policy update.",
  "shared": false,
  "disabled": false,
  "combiningAlgorithm": {
    "algorithm": "DenyOverrides"
  }
})

response = http.request(request)
puts response.read_body
let parameters = "{\n  \"id\": \"{{policyId}}\",\n  \"type\": \"Policy\",\n  \"name\": \"Test Token Authorization\",\n  \"version\": \"{{versionId}}\",\n  \"description\": \"Token authorization policy update.\",\n  \"shared\": false,\n  \"disabled\": false,\n  \"combiningAlgorithm\": {\n    \"algorithm\": \"DenyOverrides\"\n  }\n}"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "{{apiPath}}/v2/policy-manager/policies/{{policyId}}?branch={{branchId}}")!,timeoutInterval: Double.infinity)
request.addValue("{{userId}}", forHTTPHeaderField: "x-user-id")
request.addValue("application/json", forHTTPHeaderField: "Content-Type")

request.httpMethod = "PUT"
request.httpBody = postData

let task = URLSession.shared.dataTask(with: request) { data, response, error in
  guard let data = data else {
    print(String(describing: error))
    return
  }
  print(String(data: data, encoding: .utf8)!)
}

task.resume()

Example Response

200 OK

{
    "id": "ddd13d3f-7a52-4c6c-8d36-d4dad6c8616f",
    "version": "bb9fb9ee-e0bc-4bef-84c4-77724deb24dd",
    "type": "Policy",
    "name": "Test Token Authorization",
    "description": "Token authorization policy update.",
    "shared": false,
    "disabled": false,
    "combiningAlgorithm": {
        "algorithm": "DenyOverrides"
    },
    "children": [],
    "repetitionSettings": null,
    "permissions": {
        "inherit": true,
        "rolePermissions": []
    },
    "targets": [],
    "statements": [],
    "properties": [],
    "condition": null
}