PingCentral API Reference

READ Environment With Runtime Information

GET {{baseUrl}}/api/v1/environments/{{envID}}/runtime

The GET /api/v1/environments/{{envID}}/runtime endpoint returns runtime information about the environment specified by its ID in the request URL.

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/environments/{{envID}}/runtime' \
--header 'Cookie: <string>' \
--header 'X-XSRF-Header: PASS' \
--header 'Authorization: Basic e3t1c2VybmFtZX19Ont7cGFzc3dvcmR9fQ=='
var options = new RestClientOptions("{{baseUrl}}/api/v1/environments/{{envID}}/runtime")
{
  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/environments/{{envID}}/runtime"
  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/environments/{{envID}}/runtime 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/environments/{{envID}}/runtime")
  .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/environments/{{envID}}/runtime",
  "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/environments/{{envID}}/runtime',
  '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/environments/{{envID}}/runtime"

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/environments/{{envID}}/runtime');
$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/environments/{{envID}}/runtime")

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/environments/{{envID}}/runtime")!,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

{
  "pfRuntimeInfoView": "{\"issuer\":\"https://sso.anycompany.co:9031\",\"authorization_endpoint\":\"https://sso.anycompany.co:9031/as/authorization.oauth2\",\"token_endpoint\":\"https://sso.anycompany.co:9031/as/token.oauth2\",\"revocation_endpoint\":\"https://sso.anycompany.co:9031/as/revoke_token.oauth2\",\"userinfo_endpoint\":\"https://sso.anycompany.co:9031/idp/userinfo.openid\",\"introspection_endpoint\":\"https://sso.anycompany.co:9031/as/introspect.oauth2\",\"jwks_uri\":\"https://sso.anycompany.co:9031/pf/JWKS\",\"registration_endpoint\":\"https://sso.anycompany.co:9031/as/clients.oauth2\",\"ping_revoked_sris_endpoint\":\"https://sso.anycompany.co:9031/pf-ws/rest/sessionMgmt/revokedSris\",\"ping_end_session_endpoint\":\"https://sso.anycompany.co:9031/idp/startSLO.ping\",\"device_authorization_endpoint\":\"https://sso.anycompany.co:9031/as/device_authz.oauth2\",\"scopes_supported\":[\"address\",\"edit\",\"phone\",\"openid\",\"profile\",\"admin\",\"email\"],\"claims_supported\":[\"address\",\"anycompanyCustomAttribute\",\"birthdate\",\"email\",\"email_verified\",\"family_name\",\"gender\",\"given_name\",\"locale\",\"middle_name\",\"name\",\"nickname\",\"phone_number\",\"phone_number_verified\",\"picture\",\"preferred_username\",\"profile\",\"sub\",\"updated_at\",\"website\",\"zoneinfo\"],\"response_types_supported\":[\"code\",\"token\",\"id_token\",\"code token\",\"code id_token\",\"token id_token\",\"code token id_token\"],\"response_modes_supported\":[\"fragment\",\"query\",\"form_post\"],\"grant_types_supported\":[\"implicit\",\"authorization_code\",\"refresh_token\",\"password\",\"client_credentials\",\"urn:pingidentity.com:oauth2:grant_type:validate_bearer\",\"urn:ietf:params:oauth:grant-type:jwt-bearer\",\"urn:ietf:params:oauth:grant-type:saml2-bearer\",\"urn:ietf:params:oauth:grant-type:device_code\"],\"subject_types_supported\":[\"public\"],\"id_token_signing_alg_values_supported\":[\"none\",\"HS256\",\"HS384\",\"HS512\",\"RS256\",\"RS384\",\"RS512\",\"PS256\",\"PS384\",\"PS512\"],\"token_endpoint_auth_methods_supported\":[\"client_secret_basic\",\"client_secret_post\",\"private_key_jwt\"],\"token_endpoint_auth_signing_alg_values_supported\":[\"RS256\",\"RS384\",\"RS512\",\"PS256\",\"PS384\",\"PS512\"],\"claim_types_supported\":[\"normal\"],\"claims_parameter_supported\":false,\"request_parameter_supported\":true,\"request_uri_parameter_supported\":false,\"request_object_signing_alg_values_supported\":[\"RS256\",\"RS384\",\"RS512\",\"PS256\",\"PS384\",\"PS512\"],\"id_token_encryption_alg_values_supported\":[\"dir\",\"A128KW\",\"A192KW\",\"A256KW\",\"A128GCMKW\",\"A192GCMKW\",\"A256GCMKW\",\"ECDH-ES\",\"ECDH-ES+A128KW\",\"ECDH-ES+A192KW\",\"ECDH-ES+A256KW\",\"RSA-OAEP\"],\"id_token_encryption_enc_values_supported\":[\"A128CBC-HS256\",\"A192CBC-HS384\",\"A256CBC-HS512\",\"A128GCM\",\"A192GCM\",\"A256GCM\"],\"oidc_discovery_endpoint\":\"https://sso.anycompany.co:9031/.well-known/openid-configuration\"}"
}