Create Authorization Rule
POST {{apiPath}}/environments/{{envID}}/authorizationRules
The POST {{apiPath}}/environments/{{envID}}/authorizationRules request creates a new authorization rule resource.
Request Model
For property descriptions, refer to Authorization rules data model
| Property | Type? | Required? |
|---|---|---|
|
Object |
Optional |
|
String |
Optional |
|
Object |
Optional |
|
Boolean |
Optional |
|
String |
Required |
|
Object |
Optional |
|
String |
Optional |
Body
raw ( application/json )
{
"type": "RULE",
"name": "Rule1",
"description": "Rule1 description",
"enabled": true,
"statements": [
{
"type": "STATEMENT_REFERENCE",
"value": {
"id": "{{authorizationStatementID}}"
}
},
{
"type": "EMBEDDED_STATEMENT",
"name": "Statement1",
"description": "Statement1 description",
"code": "CODE1",
"appliesTo": "PERMIT_OR_DENY",
"appliesIf": "FINAL_DECISION_MATCHES",
"payload": "Payload1",
"obligatory": false,
"attributes": [],
"services": []
}
],
"condition": {
"type": "AND",
"conditions": [
{
"type": "COMPARISON",
"left": {
"type": "ATTRIBUTE",
"id": "{{authConditionsID}}"
},
"comparator": "EQUALS",
"right": {
"type": "CONSTANT",
"value": "def"
}
}
]
},
"effectSettings": {
"type": "UNCONDITIONAL_PERMIT"
}
}
Example Request
-
cURL
-
C#
-
Go
-
HTTP
-
Java
-
jQuery
-
NodeJS
-
Python
-
PHP
-
Ruby
-
Swift
curl --location --globoff '{{apiPath}}/environments/{{envID}}/authorizationRules' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
"type": "RULE",
"name": "Rule1",
"description": "Rule1 description",
"enabled": true,
"statements": [
{
"type": "STATEMENT_REFERENCE",
"value": {
"id": "{{authorizationStatementID}}"
}
},
{
"type": "EMBEDDED_STATEMENT",
"name": "Statement1",
"description": "Statement1 description",
"code": "CODE1",
"appliesTo": "PERMIT_OR_DENY",
"appliesIf": "FINAL_DECISION_MATCHES",
"payload": "Payload1",
"obligatory": false,
"attributes": [],
"services": []
}
],
"condition": {
"type": "AND",
"conditions": [
{
"type": "COMPARISON",
"left": {
"type": "ATTRIBUTE",
"id": "{{authConditionsID}}"
},
"comparator": "EQUALS",
"right": {
"type": "CONSTANT",
"value": "def"
}
}
]
},
"effectSettings": {
"type": "UNCONDITIONAL_PERMIT"
}
}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/authorizationRules")
{
MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Bearer {{accessToken}}");
var body = @"{" + "\n" +
@" ""type"": ""RULE""," + "\n" +
@" ""name"": ""Rule1""," + "\n" +
@" ""description"": ""Rule1 description""," + "\n" +
@" ""enabled"": true," + "\n" +
@" ""statements"": [" + "\n" +
@" {" + "\n" +
@" ""type"": ""STATEMENT_REFERENCE""," + "\n" +
@" ""value"": {" + "\n" +
@" ""id"": ""{{authorizationStatementID}}""" + "\n" +
@" }" + "\n" +
@" }," + "\n" +
@" {" + "\n" +
@" ""type"": ""EMBEDDED_STATEMENT""," + "\n" +
@" ""name"": ""Statement1""," + "\n" +
@" ""description"": ""Statement1 description""," + "\n" +
@" ""code"": ""CODE1""," + "\n" +
@" ""appliesTo"": ""PERMIT_OR_DENY""," + "\n" +
@" ""appliesIf"": ""FINAL_DECISION_MATCHES""," + "\n" +
@" ""payload"": ""Payload1""," + "\n" +
@" ""obligatory"": false," + "\n" +
@" ""attributes"": []," + "\n" +
@" ""services"": []" + "\n" +
@" }" + "\n" +
@" ]," + "\n" +
@" ""condition"": {" + "\n" +
@" ""type"": ""AND""," + "\n" +
@" ""conditions"": [" + "\n" +
@" {" + "\n" +
@" ""type"": ""COMPARISON""," + "\n" +
@" ""left"": {" + "\n" +
@" ""type"": ""ATTRIBUTE""," + "\n" +
@" ""id"": ""{{authConditionsID}}""" + "\n" +
@" }," + "\n" +
@" ""comparator"": ""EQUALS""," + "\n" +
@" ""right"": {" + "\n" +
@" ""type"": ""CONSTANT""," + "\n" +
@" ""value"": ""def"" " + "\n" +
@" }" + "\n" +
@" }" + "\n" +
@" ]" + "\n" +
@" }," + "\n" +
@" ""effectSettings"": {" + "\n" +
@" ""type"": ""UNCONDITIONAL_PERMIT""" + "\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}}/environments/{{envID}}/authorizationRules"
method := "POST"
payload := strings.NewReader(`{
"type": "RULE",
"name": "Rule1",
"description": "Rule1 description",
"enabled": true,
"statements": [
{
"type": "STATEMENT_REFERENCE",
"value": {
"id": "{{authorizationStatementID}}"
}
},
{
"type": "EMBEDDED_STATEMENT",
"name": "Statement1",
"description": "Statement1 description",
"code": "CODE1",
"appliesTo": "PERMIT_OR_DENY",
"appliesIf": "FINAL_DECISION_MATCHES",
"payload": "Payload1",
"obligatory": false,
"attributes": [],
"services": []
}
],
"condition": {
"type": "AND",
"conditions": [
{
"type": "COMPARISON",
"left": {
"type": "ATTRIBUTE",
"id": "{{authConditionsID}}"
},
"comparator": "EQUALS",
"right": {
"type": "CONSTANT",
"value": "def"
}
}
]
},
"effectSettings": {
"type": "UNCONDITIONAL_PERMIT"
}
}`)
client := &http.Client {
}
req, err := http.NewRequest(method, url, payload)
if err != nil {
fmt.Println(err)
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Authorization", "Bearer {{accessToken}}")
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))
}
POST /environments/{{envID}}/authorizationRules HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}
{
"type": "RULE",
"name": "Rule1",
"description": "Rule1 description",
"enabled": true,
"statements": [
{
"type": "STATEMENT_REFERENCE",
"value": {
"id": "{{authorizationStatementID}}"
}
},
{
"type": "EMBEDDED_STATEMENT",
"name": "Statement1",
"description": "Statement1 description",
"code": "CODE1",
"appliesTo": "PERMIT_OR_DENY",
"appliesIf": "FINAL_DECISION_MATCHES",
"payload": "Payload1",
"obligatory": false,
"attributes": [],
"services": []
}
],
"condition": {
"type": "AND",
"conditions": [
{
"type": "COMPARISON",
"left": {
"type": "ATTRIBUTE",
"id": "{{authConditionsID}}"
},
"comparator": "EQUALS",
"right": {
"type": "CONSTANT",
"value": "def"
}
}
]
},
"effectSettings": {
"type": "UNCONDITIONAL_PERMIT"
}
}
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"type\": \"RULE\",\n \"name\": \"Rule1\",\n \"description\": \"Rule1 description\",\n \"enabled\": true,\n \"statements\": [\n {\n \"type\": \"STATEMENT_REFERENCE\",\n \"value\": {\n \"id\": \"{{authorizationStatementID}}\"\n }\n },\n {\n \"type\": \"EMBEDDED_STATEMENT\",\n \"name\": \"Statement1\",\n \"description\": \"Statement1 description\",\n \"code\": \"CODE1\",\n \"appliesTo\": \"PERMIT_OR_DENY\",\n \"appliesIf\": \"FINAL_DECISION_MATCHES\",\n \"payload\": \"Payload1\",\n \"obligatory\": false,\n \"attributes\": [],\n \"services\": []\n }\n ],\n \"condition\": {\n \"type\": \"AND\",\n \"conditions\": [\n {\n \"type\": \"COMPARISON\",\n \"left\": {\n \"type\": \"ATTRIBUTE\",\n \"id\": \"{{authConditionsID}}\"\n },\n \"comparator\": \"EQUALS\",\n \"right\": {\n \"type\": \"CONSTANT\",\n \"value\": \"def\" \n }\n }\n ]\n },\n \"effectSettings\": {\n \"type\": \"UNCONDITIONAL_PERMIT\"\n }\n}");
Request request = new Request.Builder()
.url("{{apiPath}}/environments/{{envID}}/authorizationRules")
.method("POST", body)
.addHeader("Content-Type", "application/json")
.addHeader("Authorization", "Bearer {{accessToken}}")
.build();
Response response = client.newCall(request).execute();
var settings = {
"url": "{{apiPath}}/environments/{{envID}}/authorizationRules",
"method": "POST",
"timeout": 0,
"headers": {
"Content-Type": "application/json",
"Authorization": "Bearer {{accessToken}}"
},
"data": JSON.stringify({
"type": "RULE",
"name": "Rule1",
"description": "Rule1 description",
"enabled": true,
"statements": [
{
"type": "STATEMENT_REFERENCE",
"value": {
"id": "{{authorizationStatementID}}"
}
},
{
"type": "EMBEDDED_STATEMENT",
"name": "Statement1",
"description": "Statement1 description",
"code": "CODE1",
"appliesTo": "PERMIT_OR_DENY",
"appliesIf": "FINAL_DECISION_MATCHES",
"payload": "Payload1",
"obligatory": false,
"attributes": [],
"services": []
}
],
"condition": {
"type": "AND",
"conditions": [
{
"type": "COMPARISON",
"left": {
"type": "ATTRIBUTE",
"id": "{{authConditionsID}}"
},
"comparator": "EQUALS",
"right": {
"type": "CONSTANT",
"value": "def"
}
}
]
},
"effectSettings": {
"type": "UNCONDITIONAL_PERMIT"
}
}),
};
$.ajax(settings).done(function (response) {
console.log(response);
});
var request = require('request');
var options = {
'method': 'POST',
'url': '{{apiPath}}/environments/{{envID}}/authorizationRules',
'headers': {
'Content-Type': 'application/json',
'Authorization': 'Bearer {{accessToken}}'
},
body: JSON.stringify({
"type": "RULE",
"name": "Rule1",
"description": "Rule1 description",
"enabled": true,
"statements": [
{
"type": "STATEMENT_REFERENCE",
"value": {
"id": "{{authorizationStatementID}}"
}
},
{
"type": "EMBEDDED_STATEMENT",
"name": "Statement1",
"description": "Statement1 description",
"code": "CODE1",
"appliesTo": "PERMIT_OR_DENY",
"appliesIf": "FINAL_DECISION_MATCHES",
"payload": "Payload1",
"obligatory": false,
"attributes": [],
"services": []
}
],
"condition": {
"type": "AND",
"conditions": [
{
"type": "COMPARISON",
"left": {
"type": "ATTRIBUTE",
"id": "{{authConditionsID}}"
},
"comparator": "EQUALS",
"right": {
"type": "CONSTANT",
"value": "def"
}
}
]
},
"effectSettings": {
"type": "UNCONDITIONAL_PERMIT"
}
})
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
import requests
import json
url = "{{apiPath}}/environments/{{envID}}/authorizationRules"
payload = json.dumps({
"type": "RULE",
"name": "Rule1",
"description": "Rule1 description",
"enabled": True,
"statements": [
{
"type": "STATEMENT_REFERENCE",
"value": {
"id": "{{authorizationStatementID}}"
}
},
{
"type": "EMBEDDED_STATEMENT",
"name": "Statement1",
"description": "Statement1 description",
"code": "CODE1",
"appliesTo": "PERMIT_OR_DENY",
"appliesIf": "FINAL_DECISION_MATCHES",
"payload": "Payload1",
"obligatory": False,
"attributes": [],
"services": []
}
],
"condition": {
"type": "AND",
"conditions": [
{
"type": "COMPARISON",
"left": {
"type": "ATTRIBUTE",
"id": "{{authConditionsID}}"
},
"comparator": "EQUALS",
"right": {
"type": "CONSTANT",
"value": "def"
}
}
]
},
"effectSettings": {
"type": "UNCONDITIONAL_PERMIT"
}
})
headers = {
'Content-Type': 'application/json',
'Authorization': 'Bearer {{accessToken}}'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/environments/{{envID}}/authorizationRules');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'Content-Type' => 'application/json',
'Authorization' => 'Bearer {{accessToken}}'
));
$request->setBody('{\n "type": "RULE",\n "name": "Rule1",\n "description": "Rule1 description",\n "enabled": true,\n "statements": [\n {\n "type": "STATEMENT_REFERENCE",\n "value": {\n "id": "{{authorizationStatementID}}"\n }\n },\n {\n "type": "EMBEDDED_STATEMENT",\n "name": "Statement1",\n "description": "Statement1 description",\n "code": "CODE1",\n "appliesTo": "PERMIT_OR_DENY",\n "appliesIf": "FINAL_DECISION_MATCHES",\n "payload": "Payload1",\n "obligatory": false,\n "attributes": [],\n "services": []\n }\n ],\n "condition": {\n "type": "AND",\n "conditions": [\n {\n "type": "COMPARISON",\n "left": {\n "type": "ATTRIBUTE",\n "id": "{{authConditionsID}}"\n },\n "comparator": "EQUALS",\n "right": {\n "type": "CONSTANT",\n "value": "def" \n }\n }\n ]\n },\n "effectSettings": {\n "type": "UNCONDITIONAL_PERMIT"\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}}/environments/{{envID}}/authorizationRules")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Bearer {{accessToken}}"
request.body = JSON.dump({
"type": "RULE",
"name": "Rule1",
"description": "Rule1 description",
"enabled": true,
"statements": [
{
"type": "STATEMENT_REFERENCE",
"value": {
"id": "{{authorizationStatementID}}"
}
},
{
"type": "EMBEDDED_STATEMENT",
"name": "Statement1",
"description": "Statement1 description",
"code": "CODE1",
"appliesTo": "PERMIT_OR_DENY",
"appliesIf": "FINAL_DECISION_MATCHES",
"payload": "Payload1",
"obligatory": false,
"attributes": [],
"services": []
}
],
"condition": {
"type": "AND",
"conditions": [
{
"type": "COMPARISON",
"left": {
"type": "ATTRIBUTE",
"id": "{{authConditionsID}}"
},
"comparator": "EQUALS",
"right": {
"type": "CONSTANT",
"value": "def"
}
}
]
},
"effectSettings": {
"type": "UNCONDITIONAL_PERMIT"
}
})
response = http.request(request)
puts response.read_body
let parameters = "{\n \"type\": \"RULE\",\n \"name\": \"Rule1\",\n \"description\": \"Rule1 description\",\n \"enabled\": true,\n \"statements\": [\n {\n \"type\": \"STATEMENT_REFERENCE\",\n \"value\": {\n \"id\": \"{{authorizationStatementID}}\"\n }\n },\n {\n \"type\": \"EMBEDDED_STATEMENT\",\n \"name\": \"Statement1\",\n \"description\": \"Statement1 description\",\n \"code\": \"CODE1\",\n \"appliesTo\": \"PERMIT_OR_DENY\",\n \"appliesIf\": \"FINAL_DECISION_MATCHES\",\n \"payload\": \"Payload1\",\n \"obligatory\": false,\n \"attributes\": [],\n \"services\": []\n }\n ],\n \"condition\": {\n \"type\": \"AND\",\n \"conditions\": [\n {\n \"type\": \"COMPARISON\",\n \"left\": {\n \"type\": \"ATTRIBUTE\",\n \"id\": \"{{authConditionsID}}\"\n },\n \"comparator\": \"EQUALS\",\n \"right\": {\n \"type\": \"CONSTANT\",\n \"value\": \"def\" \n }\n }\n ]\n },\n \"effectSettings\": {\n \"type\": \"UNCONDITIONAL_PERMIT\"\n }\n}"
let postData = parameters.data(using: .utf8)
var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/authorizationRules")!,timeoutInterval: Double.infinity)
request.addValue("application/json", forHTTPHeaderField: "Content-Type")
request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization")
request.httpMethod = "POST"
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
201 Created
{
"_links": {
"self": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/authorizationRules/bdb2f5ac-f0a5-490e-bd01-3aff8682d898"
},
"environment": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
}
},
"id": "bdb2f5ac-f0a5-490e-bd01-3aff8682d898",
"name": "Rule10",
"description": "Rule10 description",
"enabled": true,
"statements": [
{
"value": {
"id": "20a1d298-ca8d-4e58-859f-b2b8d123286d"
}
},
{
"name": "Statement1",
"description": "Statement1 description",
"code": "CODE1",
"appliesTo": "PERMIT_OR_DENY",
"appliesIf": "FINAL_DECISION_MATCHES",
"payload": "Payload1",
"obligatory": false,
"attributes": []
}
],
"condition": {
"type": "AND",
"conditions": [
{
"type": "COMPARISON",
"left": {
"type": "ATTRIBUTE",
"id": "a82a932f-f8bd-4b05-8c1f-5cf75c8fc030"
},
"comparator": "EQUALS",
"right": {
"type": "CONSTANT",
"value": "def"
}
}
]
},
"effectSettings": {
"type": "UNCONDITIONAL_PERMIT"
},
"version": "5e121ef3-8342-4b4d-bd94-716ba1753a33"
}