PingCentral API Reference

READ PingAccess Dependent Resources

GET {{baseUrl}}/api/v1/orchestration/pingaccess/environments/{{envID}}/dependentResources?invalidateCacheEntry=false

the GET /api/v1/orchestration/pingaccess/environments/{{envID}}/dependentResources endpoint returns a list of all PingAccess dependent resources.

Headers

Authorization

Cookie      <string>

X-XSRF-Header      PASS

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff '{{baseUrl}}/api/v1/orchestration/pingaccess/environments/{{envID}}/dependentResources?invalidateCacheEntry=false' \
--header 'Cookie: <string>' \
--header 'X-XSRF-Header: PASS' \
--header 'Authorization: Basic e3t1c2VybmFtZX19Ont7cGFzc3dvcmR9fQ=='
var options = new RestClientOptions("{{baseUrl}}/api/v1/orchestration/pingaccess/environments/{{envID}}/dependentResources?invalidateCacheEntry=false")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Get);
request.AddHeader("Cookie", "<string>");
request.AddHeader("X-XSRF-Header", "PASS");
request.AddHeader("Authorization", "Basic e3t1c2VybmFtZX19Ont7cGFzc3dvcmR9fQ==");
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
package main

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

func main() {

  url := "{{baseUrl}}/api/v1/orchestration/pingaccess/environments/{{envID}}/dependentResources?invalidateCacheEntry=false"
  method := "GET"

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

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Cookie", "<string>")
  req.Header.Add("X-XSRF-Header", "PASS")
  req.Header.Add("Authorization", "Basic e3t1c2VybmFtZX19Ont7cGFzc3dvcmR9fQ==")

  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 /api/v1/orchestration/pingaccess/environments/{{envID}}/dependentResources?invalidateCacheEntry=false HTTP/1.1
Host: {{baseUrl}}
Cookie: <string>
X-XSRF-Header: PASS
Authorization: Basic e3t1c2VybmFtZX19Ont7cGFzc3dvcmR9fQ==
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("{{baseUrl}}/api/v1/orchestration/pingaccess/environments/{{envID}}/dependentResources?invalidateCacheEntry=false")
  .method("GET", body)
  .addHeader("Cookie", "<string>")
  .addHeader("X-XSRF-Header", "PASS")
  .addHeader("Authorization", "Basic e3t1c2VybmFtZX19Ont7cGFzc3dvcmR9fQ==")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{baseUrl}}/api/v1/orchestration/pingaccess/environments/{{envID}}/dependentResources?invalidateCacheEntry=false",
  "method": "GET",
  "timeout": 0,
  "headers": {
    "Cookie": "<string>",
    "X-XSRF-Header": "PASS",
    "Authorization": "Basic e3t1c2VybmFtZX19Ont7cGFzc3dvcmR9fQ=="
  },
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'GET',
  'url': '{{baseUrl}}/api/v1/orchestration/pingaccess/environments/{{envID}}/dependentResources?invalidateCacheEntry=false',
  'headers': {
    'Cookie': '<string>',
    'X-XSRF-Header': 'PASS',
    'Authorization': 'Basic e3t1c2VybmFtZX19Ont7cGFzc3dvcmR9fQ=='
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
import requests

url = "{{baseUrl}}/api/v1/orchestration/pingaccess/environments/{{envID}}/dependentResources?invalidateCacheEntry=false"

payload = {}
headers = {
  'Cookie': '<string>',
  'X-XSRF-Header': 'PASS',
  'Authorization': 'Basic e3t1c2VybmFtZX19Ont7cGFzc3dvcmR9fQ=='
}

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

print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{baseUrl}}/api/v1/orchestration/pingaccess/environments/{{envID}}/dependentResources?invalidateCacheEntry=false');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Cookie' => '<string>',
  'X-XSRF-Header' => 'PASS',
  'Authorization' => 'Basic e3t1c2VybmFtZX19Ont7cGFzc3dvcmR9fQ=='
));
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("{{baseUrl}}/api/v1/orchestration/pingaccess/environments/{{envID}}/dependentResources?invalidateCacheEntry=false")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["Cookie"] = "<string>"
request["X-XSRF-Header"] = "PASS"
request["Authorization"] = "Basic e3t1c2VybmFtZX19Ont7cGFzc3dvcmR9fQ=="

response = http.request(request)
puts response.read_body
var request = URLRequest(url: URL(string: "{{baseUrl}}/api/v1/orchestration/pingaccess/environments/{{envID}}/dependentResources?invalidateCacheEntry=false")!,timeoutInterval: Double.infinity)
request.addValue("<string>", forHTTPHeaderField: "Cookie")
request.addValue("PASS", forHTTPHeaderField: "X-XSRF-Header")
request.addValue("Basic e3t1c2VybmFtZX19Ont7cGFzc3dvcmR9fQ==", forHTTPHeaderField: "Authorization")

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

{
  "accessTokenValidatorSummaries": [
    {
      "className": "com.pingidentity.pa.accesstokenvalidators.JwksEndpoint",
      "configuration": "\"configuration\": {}",
      "id": 1,
      "name": "Validator Name"
    }
  ],
  "agentSummaries": [
    {
      "description": "Description of the agent.",
      "hostname": "localhost",
      "id": 1,
      "name": "Agent Name",
      "port": 9000
    }
  ],
  "identityMappingSummaries": [
    {
      "className": "com.pingidentity.pa.identitymappings.HeaderIdentityMapping",
      "configuration": "\"configuration\": {}",
      "id": 1,
      "name": "Mapping Name"
    }
  ],
  "loadedTime": "2021-01-14T23:17:06.020Z",
  "siteAuthenticatorSummaries": [
    {
      "id": 1,
      "name": "Authenticator Name"
    }
  ],
  "siteSummaries": [
    {
      "id": 1,
      "name": "Site Name",
      "secure": true,
      "siteAuthenticatorIds": [
        "1",
        "2"
      ],
      "targets": [
        "localhost:80"
      ]
    }
  ],
  "virtualHostSummaries": [
    {
      "host": "localhost",
      "id": 1,
      "port": 6000
    }
  ],
  "webSessionSummaries": [
    {
      "audience": "aud",
      "clientCredentials": "\"clientCredentials\": {\"clientId\": \"pa_rs\"}",
      "clientId": "clientId",
      "cookieDomain": "pingidentity.com",
      "cookieType": "Encrypted",
      "httpOnlyCookie": true,
      "id": 1,
      "name": "Web Session Name",
      "oidcLoginType": "Code",
      "sameSite": "Lax",
      "scopes": [
        "address",
        "email"
      ],
      "secureCookie": true,
      "validateSessionIsAlive": true
    }
  ]
}