PingAuthorize API Reference

Authorize Client with Individual Decision

POST {{apiPath}}/governance-engine

The POST /governance-engine operation authorizes the client using an individual request. On successful client authorization, the JSON PDP API invokes the Policy Decision Service.

Headers

Authorization      Bearer {{accessToken}}

Content-Type      application/json

Accept      application/json

Body

raw ( application/json )

{
  "domain": "Sales.Asia Pacific",
  "action": "Retrieve",
  "service": "Mobile.Landing page",
  "identityProvider": "Social Networks.Spacebook",
  "attributes": {
    "Prospect name": "B. Vo"
  }
}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff '{{apiPath}}/governance-engine' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
  "domain": "Sales.Asia Pacific",
  "action": "Retrieve",
  "service": "Mobile.Landing page",
  "identityProvider": "Social Networks.Spacebook",
  "attributes": {
    "Prospect name": "B. Vo"
  }
}'
var options = new RestClientOptions("{{apiPath}}/governance-engine")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Accept", "application/json");
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Bearer {{accessToken}}");
var body = @"{" + "\n" +
@"  ""domain"": ""Sales.Asia Pacific""," + "\n" +
@"  ""action"": ""Retrieve""," + "\n" +
@"  ""service"": ""Mobile.Landing page""," + "\n" +
@"  ""identityProvider"": ""Social Networks.Spacebook""," + "\n" +
@"  ""attributes"": {" + "\n" +
@"    ""Prospect name"": ""B. Vo""" + "\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}}/governance-engine"
  method := "POST"

  payload := strings.NewReader(`{
  "domain": "Sales.Asia Pacific",
  "action": "Retrieve",
  "service": "Mobile.Landing page",
  "identityProvider": "Social Networks.Spacebook",
  "attributes": {
    "Prospect name": "B. Vo"
  }
}`)

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

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Accept", "application/json")
  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 /governance-engine HTTP/1.1
Host: {{apiPath}}
Accept: application/json
Content-Type: application/json
Authorization: Bearer {{accessToken}}

{
  "domain": "Sales.Asia Pacific",
  "action": "Retrieve",
  "service": "Mobile.Landing page",
  "identityProvider": "Social Networks.Spacebook",
  "attributes": {
    "Prospect name": "B. Vo"
  }
}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n  \"domain\": \"Sales.Asia Pacific\",\n  \"action\": \"Retrieve\",\n  \"service\": \"Mobile.Landing page\",\n  \"identityProvider\": \"Social Networks.Spacebook\",\n  \"attributes\": {\n    \"Prospect name\": \"B. Vo\"\n  }\n}");
Request request = new Request.Builder()
  .url("{{apiPath}}/governance-engine")
  .method("POST", body)
  .addHeader("Accept", "application/json")
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{apiPath}}/governance-engine",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "Accept": "application/json",
    "Content-Type": "application/json",
    "Authorization": "Bearer {{accessToken}}"
  },
  "data": JSON.stringify({
    "domain": "Sales.Asia Pacific",
    "action": "Retrieve",
    "service": "Mobile.Landing page",
    "identityProvider": "Social Networks.Spacebook",
    "attributes": {
      "Prospect name": "B. Vo"
    }
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'POST',
  'url': '{{apiPath}}/governance-engine',
  'headers': {
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'Authorization': 'Bearer {{accessToken}}'
  },
  body: JSON.stringify({
    "domain": "Sales.Asia Pacific",
    "action": "Retrieve",
    "service": "Mobile.Landing page",
    "identityProvider": "Social Networks.Spacebook",
    "attributes": {
      "Prospect name": "B. Vo"
    }
  })

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

url = "{{apiPath}}/governance-engine"

payload = json.dumps({
  "domain": "Sales.Asia Pacific",
  "action": "Retrieve",
  "service": "Mobile.Landing page",
  "identityProvider": "Social Networks.Spacebook",
  "attributes": {
    "Prospect name": "B. Vo"
  }
})
headers = {
  'Accept': 'application/json',
  '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}}/governance-engine');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Accept' => 'application/json',
  'Content-Type' => 'application/json',
  'Authorization' => 'Bearer {{accessToken}}'
));
$request->setBody('{\n  "domain": "Sales.Asia Pacific",\n  "action": "Retrieve",\n  "service": "Mobile.Landing page",\n  "identityProvider": "Social Networks.Spacebook",\n  "attributes": {\n    "Prospect name": "B. Vo"\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}}/governance-engine")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"
request["Authorization"] = "Bearer {{accessToken}}"
request.body = JSON.dump({
  "domain": "Sales.Asia Pacific",
  "action": "Retrieve",
  "service": "Mobile.Landing page",
  "identityProvider": "Social Networks.Spacebook",
  "attributes": {
    "Prospect name": "B. Vo"
  }
})

response = http.request(request)
puts response.read_body
let parameters = "{\n  \"domain\": \"Sales.Asia Pacific\",\n  \"action\": \"Retrieve\",\n  \"service\": \"Mobile.Landing page\",\n  \"identityProvider\": \"Social Networks.Spacebook\",\n  \"attributes\": {\n    \"Prospect name\": \"B. Vo\"\n  }\n}"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "{{apiPath}}/governance-engine")!,timeoutInterval: Double.infinity)
request.addValue("application/json", forHTTPHeaderField: "Accept")
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

200 OK

{
    "id": "12345678-90ab-cdef-1234-567890abcdef",
    "deploymentPackageId": "12345678-90ab-cdef-1234-567890abcdef",
    "timestamp": "2021-06-11T03:12:19.720485Z",
    "elapsedTime": 184024,
    "decision": "PERMIT",
    "authorized": true,
    "statements": [
        {
            "id": "12345678-90ab-cdef-1234-567890abcdef",
            "name": "Statement Name",
            "code": "statement-code",
            "payload": "{\"data\": \"some data\"}",
            "obligatory": true,
            "fulfilled": false,
            "attributes": {}
        }
    ],
    "status": {
        "code": "OKAY",
        "messages": [],
        "errors": []
    }
}