PingAuthorize API Reference

Read All Targets

GET {{apiPath}}/v2/policy-manager/targets?branch={{branchId}}

The GET /v2/policy-manager/targets operation returns a list of all targets defined in the system. The request must provide either a branch ID or a snapshot ID in the request URL to specify where the targets should be read from.

Prerequisites

Query parameters
Query parameter Description

branch

Branch ID or name.

snapshot

Snapshot ID.

page

Specifies the page number of results to return.

page-size

Specifies the number of results to return per page.

onlyShared

true to only list targets shared by policy entities or false to list all targets defined in the system.

Headers

x-user-id      {{userId}}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff '{{apiPath}}/v2/policy-manager/targets?branch={{branchId}}' \
--header 'x-user-id: {{userId}}'
var options = new RestClientOptions("{{apiPath}}/v2/policy-manager/targets?branch={{branchId}}")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Get);
request.AddHeader("x-user-id", "{{userId}}");
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
package main

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

func main() {

  url := "{{apiPath}}/v2/policy-manager/targets?branch={{branchId}}"
  method := "GET"

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

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

  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))
}
GET /v2/policy-manager/targets?branch={{branchId}} HTTP/1.1
Host: {{apiPath}}
x-user-id: {{userId}}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("{{apiPath}}/v2/policy-manager/targets?branch={{branchId}}")
  .method("GET", body)
  .addHeader("x-user-id", "{{userId}}")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{apiPath}}/v2/policy-manager/targets?branch={{branchId}}",
  "method": "GET",
  "timeout": 0,
  "headers": {
    "x-user-id": "{{userId}}"
  },
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'GET',
  'url': '{{apiPath}}/v2/policy-manager/targets?branch={{branchId}}',
  'headers': {
    'x-user-id': '{{userId}}'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
import requests

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

payload = {}
headers = {
  'x-user-id': '{{userId}}'
}

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

print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/v2/policy-manager/targets?branch={{branchId}}');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'x-user-id' => '{{userId}}'
));
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 "net/http"

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

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["x-user-id"] = "{{userId}}"

response = http.request(request)
puts response.read_body
var request = URLRequest(url: URL(string: "{{apiPath}}/v2/policy-manager/targets?branch={{branchId}}")!,timeoutInterval: Double.infinity)
request.addValue("{{userId}}", forHTTPHeaderField: "x-user-id")

request.httpMethod = "GET"

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

{
    "pagination": {
        "page": 1,
        "pageSize": 100,
        "totalItems": 13,
        "totalPages": 1
    },
    "data": [
        {
            "id": "c6ba1a0d-5711-4c98-9ad4-e24602214c43",
            "version": "5593e490-9f88-421a-85fa-3297411c7aab",
            "type": "Target",
            "name": "example-target",
            "description": "",
            "shared": true,
            "permissions": {
                "inherit": true,
                "rolePermissions": []
            },
            "properties": [],
            "targeted": {}
        },
        {
            "id": "0246aa6c-b080-4aa8-a536-2bf29855dce3",
            "version": "0b5a0c7e-12c7-4ad8-89c0-78fc492e090e",
            "type": "Target",
            "name": "example-target",
            "description": "",
            "shared": true,
            "permissions": {
                "inherit": true,
                "rolePermissions": []
            },
            "properties": [],
            "targeted": {}
        },
        {
            "id": "e5148a0c-88cd-41a7-8d68-76642571ec79",
            "version": "c29808bc-4498-4237-aa5a-6b91b1d8294f",
            "type": "Target",
            "name": "Inline target",
            "description": "",
            "shared": false,
            "permissions": {
                "inherit": true,
                "rolePermissions": []
            },
            "properties": [],
            "targeted": {
                "actions": [
                    "44da9abd-3299-45b2-bc23-7e76ecfde490"
                ]
            }
        },
        {
            "id": "e41403c2-589e-4981-a088-3e004aef4d59",
            "version": "e24dcc53-9b71-47bb-8826-8dee1413ac9b",
            "type": "Target",
            "name": "Inline target",
            "description": "",
            "shared": false,
            "permissions": {
                "inherit": true,
                "rolePermissions": []
            },
            "properties": [],
            "targeted": {
                "services": [
                    "25769e5c-5b33-4daf-9780-3e09b6f32207"
                ]
            }
        },
        {
            "id": "d3f5486d-15a2-4612-b799-df835d170861",
            "version": "bb74d9aa-c58e-4866-b98a-db65756b3fdd",
            "type": "Target",
            "name": "Inline target",
            "description": "",
            "shared": false,
            "permissions": {
                "inherit": true,
                "rolePermissions": []
            },
            "properties": [],
            "targeted": {
                "actions": [
                    "9592ecbc-68c4-4d1a-980a-eeb6a3b4c209"
                ]
            }
        },
        {
            "id": "ba86bc60-6ae8-4e14-a4b7-ba6c5e3a463f",
            "version": "13253f35-ae8f-4444-92c8-1b7ef2e226c7",
            "type": "Target",
            "name": "Inline target",
            "description": "",
            "shared": false,
            "permissions": {
                "inherit": true,
                "rolePermissions": []
            },
            "properties": [],
            "targeted": {
                "actions": [
                    "5c34b551-1dc4-4605-999b-6f1ec2bbe526"
                ]
            }
        },
        {
            "id": "97fe7666-efe0-4506-804b-fb6b226081b5",
            "version": "925d7b64-8c4c-476c-b10c-389e94175ca0",
            "type": "Target",
            "name": "Inline target",
            "description": "",
            "shared": false,
            "permissions": {
                "inherit": true,
                "rolePermissions": []
            },
            "properties": [],
            "targeted": {
                "services": [
                    "443cc6a7-32a1-4481-acf9-fce7ebb5f424"
                ],
                "actions": [
                    "fb80c5c9-b9fb-45be-aa1f-18e8aba0e3a6"
                ]
            }
        },
        {
            "id": "926a878c-8baf-44c4-9d64-c1633b4d4473",
            "version": "9d624a95-4c81-43cc-a17f-c30549518755",
            "type": "Target",
            "name": "Inline target",
            "description": "",
            "shared": false,
            "permissions": {
                "inherit": true,
                "rolePermissions": []
            },
            "properties": [],
            "targeted": {
                "services": [
                    "c0cd2d08-7219-4ef3-a2ec-e869a4920cef"
                ]
            }
        },
        {
            "id": "8a5f7d6e-0144-4b21-9f1f-80f3cdcd491f",
            "version": "69b52e94-5891-4a62-9499-b3dcb99627a1",
            "type": "Target",
            "name": "Inline target",
            "description": "",
            "shared": false,
            "permissions": {
                "inherit": true,
                "rolePermissions": []
            },
            "properties": [],
            "targeted": {
                "actions": [
                    "9592ecbc-68c4-4d1a-980a-eeb6a3b4c209"
                ]
            }
        },
        {
            "id": "70f0101d-4cf8-432f-a39c-bdcf42c7b91d",
            "version": "cecca26b-4324-40d9-be35-9908fe9490c6",
            "type": "Target",
            "name": "Inline target",
            "description": "",
            "shared": false,
            "permissions": {
                "inherit": true,
                "rolePermissions": []
            },
            "properties": [],
            "targeted": {
                "actions": [
                    "cbbf13bf-0827-4d23-accc-190fb633b908",
                    "0338888f-fd67-45d1-9ebd-db4457a6bc09"
                ]
            }
        },
        {
            "id": "6d027bd5-6601-4e1c-a696-79cf3ce63853",
            "version": "25263aa3-7406-4d0f-a191-f02717aaed61",
            "type": "Target",
            "name": "Inline target",
            "description": "",
            "shared": false,
            "permissions": {
                "inherit": true,
                "rolePermissions": []
            },
            "properties": [],
            "targeted": {
                "services": [
                    "5e52e369-f83e-40f9-a33c-b70041b30680"
                ],
                "actions": [
                    "b072d76e-0085-4423-99c2-4e16b74e88fa"
                ]
            }
        },
        {
            "id": "6819fb38-a466-4cfc-a3eb-0f778e1b6152",
            "version": "fd62f477-77b8-49b5-880b-9fd79629b568",
            "type": "Target",
            "name": "Inline target",
            "description": "",
            "shared": false,
            "permissions": {
                "inherit": true,
                "rolePermissions": []
            },
            "properties": [],
            "targeted": {
                "actions": [
                    "4a681458-0582-4228-8eea-d563b3b5eba4"
                ]
            }
        },
        {
            "id": "3dc0fdf6-3c78-4edf-8042-0709983bece9",
            "version": "1027fcf1-f332-4618-a47f-1cc891b4f150",
            "type": "Target",
            "name": "Inline target",
            "description": "",
            "shared": false,
            "permissions": {
                "inherit": true,
                "rolePermissions": []
            },
            "properties": [],
            "targeted": {
                "actions": [
                    "9592ecbc-68c4-4d1a-980a-eeb6a3b4c209"
                ]
            }
        }
    ]
}