PingCentral API Reference

READ One Application

GET {{baseUrl}}/api/v1/applications/{{appID}}

The GET /api/v1/applications/{{appID}} endpoint returns information about the application 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/applications/{{appID}}' \
--header 'Cookie: <string>' \
--header 'X-XSRF-Header: PASS' \
--header 'Authorization: Basic e3t1c2VybmFtZX19Ont7cGFzc3dvcmR9fQ=='
var options = new RestClientOptions("{{baseUrl}}/api/v1/applications/{{appID}}")
{
  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/applications/{{appID}}"
  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/applications/{{appID}} 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/applications/{{appID}}")
  .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/applications/{{appID}}",
  "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/applications/{{appID}}',
  '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/applications/{{appID}}"

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/applications/{{appID}}');
$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/applications/{{appID}}")

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/applications/{{appID}}")!,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

{
  "applications": {
    "items": [
      {
        "type": "OAuth",
        "id": "500a0d94-d02c-4215-b7eb-898470e80cca",
        "templateId": null,
        "created": "2021-01-11T23:08:23.072767Z",
        "modified": "2021-01-11T23:08:23.072767Z",
        "name": "application445123",
        "environmentId": "aef8a7a9-0e58-4955-9841-aae7daf466d3",
        "description": null,
        "applicationOwners": [
          "a6e1134b-b33a-4fdb-a6b9-972baf75cd2f"
        ],
        "unmanaged": false,
        "pingcentralVersion": "1.7.0-SNAPSHOT",
        "enabled": true,
        "clientName": "application445123",
        "clientId": "16e09d0f-70eb-4a7f-b928-85a46398b29f",
        "redirectUris": {
          "aef8a7a9-0e58-4955-9841-aae7daf466d3": [
            "http://ping.com"
          ]
        },
        "clientSecrets": {},
        "client": "{\"clientId\":\"16e09d0f-70eb-4a7f-b928-85a46398b29f\",\"enabled\":true,\"redirectUris\":[\"http://ping.com\"],\"grantTypes\":[\"AUTHORIZATION_CODE\",\"REFRESH_TOKEN\"],\"name\":\"application445123\",\"refreshRolling\":\"SERVER_DEFAULT\",\"persistentGrantExpirationType\":\"SERVER_DEFAULT\",\"persistentGrantExpirationTime\":0,\"persistentGrantExpirationTimeUnit\":\"DAYS\",\"persistentGrantIdleTimeoutType\":\"SERVER_DEFAULT\",\"persistentGrantIdleTimeout\":0,\"persistentGrantIdleTimeoutTimeUnit\":\"DAYS\",\"bypassApprovalPage\":true,\"restrictScopes\":false,\"restrictedScopes\":\"<RESTRICTED_SCOPES>\",\"exclusiveScopes\":\"<EXCLUSIVE_SCOPES>\",\"restrictedResponseTypes\":[],\"validateUsingAllEligibleAtms\":false,\"oidcPolicy\":{\"idTokenSigningAlgorithm\":\"HS256\",\"policyGroup\":{\"id\":\"OAuthPlayground\",\"location\":\"https://it-rhel76-pf92-java11-stg-ac01-44-81:9999/pf-admin-api/v1/oauth/openIdConnect/policies/OAuthPlayground\"},\"grantAccessSessionRevocationApi\":false,\"pingAccessLogoutCapable\":false},\"clientAuth\":{\"type\":\"SECRET\",\"encryptedSecret\":\"OBF:JWE:eyJhbGciOiJkaXIiLCJlbmMiOiJBMTI4Q0JDLUhTMjU2Iiwia2lkIjoiUEtSV013NFQ4eiIsInZlcnNpb24iOiI5LjIuMy4wIn0..O9ENTjABbuKQ5yOxZ1Hlhw.YCZMsh2awkbnF6igf8ARjDqt_1MHJ8Gw1uX_nbkRv8UMXEuZHfc5OnA-zeqmelqG4YBloQK69HTRs6cIjbGiV57HfprK7smjo5mQ3aVKFFQ.7j_OFAboioEVL2cBsKUEYQ\",\"enforceReplayPrevention\":false},\"extendedParameters\":{},\"deviceFlowSettingType\":\"SERVER_DEFAULT\",\"requireSignedRequests\":false,\"__OasisClientAccessTokenMappingIds__\":[\"default|jwt\"]}",
        "oidcPolicy": "{\"id\":\"OAuthPlayground\",\"name\":\"OAuthPlayground\",\"idTokenLifetime\":5,\"attributeContract\":{\"coreAttributes\":[{\"name\":\"sub\"}],\"extendedAttributes\":[{\"name\":\"zoneinfo\"},{\"name\":\"website\"},{\"name\":\"address.locality\"},{\"name\":\"birthdate\"},{\"name\":\"email_verified\"},{\"name\":\"gender\"},{\"name\":\"profile\"},{\"name\":\"phone_number_verified\"},{\"name\":\"preferred_username\"},{\"name\":\"locale\"},{\"name\":\"given_name\"},{\"name\":\"middle_name\"},{\"name\":\"picture\"},{\"name\":\"address.country\"},{\"name\":\"updated_at\"},{\"name\":\"address.postal_code\"},{\"name\":\"address.region\"},{\"name\":\"nickname\"},{\"name\":\"name\"},{\"name\":\"phone_number\"},{\"name\":\"address.formatted\"},{\"name\":\"family_name\"},{\"name\":\"email\"},{\"name\":\"address.street_address\"}]},\"attributeMapping\":{\"attributeSources\":[],\"attributeContractFulfillment\":{\"sub\":{\"source\":{\"type\":\"TOKEN\"},\"value\":\"Username\"},\"zoneinfo\":{\"source\":{\"type\":\"TEXT\"},\"value\":\"America/New_York\"},\"address.locality\":{\"source\":{\"type\":\"TEXT\"},\"value\":\"Smallville\"},\"birthdate\":{\"source\":{\"type\":\"TEXT\"},\"value\":\"1977-12-31\"},\"gender\":{\"source\":{\"type\":\"TEXT\"},\"value\":\"female\"},\"preferred_username\":{\"source\":{\"type\":\"TEXT\"},\"value\":\"mgsample\"},\"locale\":{\"source\":{\"type\":\"TEXT\"},\"value\":\"en_US\"},\"address.country\":{\"source\":{\"type\":\"TEXT\"},\"value\":\"USA\"},\"updated_at\":{\"source\":{\"type\":\"TEXT\"},\"value\":\"2011-01-03T23:58:42+0000\"},\"address.postal_code\":{\"source\":{\"type\":\"TEXT\"},\"value\":\"11223\"},\"address.region\":{\"source\":{\"type\":\"TEXT\"},\"value\":\"ME\"},\"nickname\":{\"source\":{\"type\":\"TEXT\"},\"value\":\"Name\"},\"email\":{\"source\":{\"type\":\"TEXT\"},\"value\":\"auser@example.com\"},\"website\":{\"source\":{\"type\":\"TEXT\"},\"value\":\"https://www.pingidentity.com/\"},\"email_verified\":{\"source\":{\"type\":\"TEXT\"},\"value\":\"true\"},\"profile\":{\"source\":{\"type\":\"TEXT\"},\"value\":\"https://www.pingidentity.com/products/pingfederate/\"},\"phone_number_verified\":{\"source\":{\"type\":\"TEXT\"},\"value\":\"true\"},\"given_name\":{\"source\":{\"type\":\"TEXT\"},\"value\":\"Mary\"},\"middle_name\":{\"source\":{\"type\":\"TEXT\"},\"value\":\"Good\"},\"picture\":{\"source\":{\"type\":\"TEXT\"},\"value\":\"https://www.pingidentity.com/images/ping-logo.png\"},\"name\":{\"source\":{\"type\":\"TEXT\"},\"value\":\"Mary Good Sample\"},\"phone_number\":{\"source\":{\"type\":\"TEXT\"},\"value\":\"(555) 555-5555\"},\"address.formatted\":{\"source\":{\"type\":\"TEXT\"},\"value\":\"123 Main Street, Smallville, ME USA 11223\"},\"family_name\":{\"source\":{\"type\":\"TEXT\"},\"value\":\"Sample\"},\"address.street_address\":{\"source\":{\"type\":\"TEXT\"},\"value\":\"123 Main Street\"}},\"issuanceCriteria\":{\"conditionalCriteria\":[]}},\"includeSriInIdToken\":false,\"includeUserInfoInIdToken\":false,\"includeSHashInIdToken\":false,\"accessTokenManagerRef\":{\"id\":\"jwt\",\"location\":\"https://it-rhel76-pf92-java11-stg-ac01-44-81:9999/pf-admin-api/v1/oauth/accessTokenManagers/jwt\"},\"scopeAttributeMappings\":{}}",
        "atm": "[{\"id\":\"jwt\",\"name\":\"JSON Web Tokens\",\"pluginDescriptorRef\":{\"id\":\"com.pingidentity.pf.access.token.management.plugins.JwtBearerAccessTokenManagementPlugin\",\"location\":\"https://it-rhel76-pf92-java11-stg-ac01-44-81:9999/pf-admin-api/v1/oauth/accessTokenManagers/descriptors/com.pingidentity.pf.access.token.management.plugins.JwtBearerAccessTokenManagementPlugin\"},\"configuration\":{\"tables\":[{\"name\":\"Symmetric Keys\",\"rows\":[]},{\"name\":\"Certificates\",\"rows\":[{\"fields\":[{\"name\":\"Key ID\",\"value\":\"k1\"},{\"name\":\"Certificate\",\"value\":\"4k5excd8s7eg3qsgwpcbks22s\"},{\"name\":\"__OasisCertificateInfo__\",\"value\":{\"id\":\"4k5excd8s7eg3qsgwpcbks22s\",\"serialNumber\":\"1534531529392\",\"subjectDN\":\"CN=Config Signing Cert, OU=Dev, O=Ping, L=Denver, ST=CO, C=US\",\"subjectAlternativeNames\":[],\"issuerDN\":\"CN=Config Signing Cert, OU=Dev, O=Ping, L=Denver, ST=CO, C=US\",\"validFrom\":\"2018-08-17T18:45:29.000Z\",\"expires\":\"2033-08-13T18:45:29.000Z\",\"keyAlgorithm\":\"RSA\",\"keySize\":2048,\"signatureAlgorithm\":\"SHA256withRSA\",\"version\":3,\"sha1Fingerprint\":\"45B0B853EBFC203084FDAFE445E4E6F0E85CF281\",\"sha256Fingerprint\":\"1BD62152BE57E4A5D6A25728B45E21A81A9F75819CA970E890BE5EAED1887CC1\",\"status\":\"VALID\"}}]}]}],\"fields\":[{\"name\":\"Token Lifetime\",\"value\":\"120\"},{\"name\":\"JWS Algorithm\",\"value\":\"RS256\"},{\"name\":\"Active Symmetric Key ID\",\"value\":\"\"},{\"name\":\"Active Signing Certificate Key ID\",\"value\":\"k1\"},{\"name\":\"JWE Algorithm\",\"value\":\"\"},{\"name\":\"JWE Content Encryption Algorithm\",\"value\":\"\"},{\"name\":\"Active Symmetric Encryption Key ID\",\"value\":\"\"},{\"name\":\"Asymmetric Encryption Key\",\"value\":\"\"},{\"name\":\"Asymmetric Encryption JWKS URL\",\"value\":\"\"},{\"name\":\"Include Key ID Header Parameter\",\"value\":\"true\"},{\"name\":\"Include X.509 Thumbprint Header Parameter\",\"value\":\"false\"},{\"name\":\"Default JWKS URL Cache Duration\",\"value\":\"720\"},{\"name\":\"Include JWE Key ID Header Parameter\",\"value\":\"true\"},{\"name\":\"Include JWE X.509 Thumbprint Header Parameter\",\"value\":\"false\"},{\"name\":\"Client ID Claim Name\",\"value\":\"client_id_name\"},{\"name\":\"Scope Claim Name\",\"value\":\"scope\"},{\"name\":\"Space Delimit Scope Values\",\"value\":\"false\"},{\"name\":\"Issuer Claim Value\",\"value\":\"\"},{\"name\":\"Audience Claim Value\",\"value\":\"\"},{\"name\":\"JWT ID Claim Length\",\"value\":\"0\"},{\"name\":\"Access Grant GUID Claim Name\",\"value\":\"agid\"},{\"name\":\"JWKS Endpoint Path\",\"value\":\"\"},{\"name\":\"JWKS Endpoint Cache Duration\",\"value\":\"720\"},{\"name\":\"Publish Key ID X.509 URL\",\"value\":\"false\"},{\"name\":\"Publish Thumbprint X.509 URL\",\"value\":\"false\"}]},\"attributeContract\":{\"coreAttributes\":[],\"extendedAttributes\":[{\"name\":\"Username\"},{\"name\":\"OrgName\"}]},\"selectionSettings\":{\"resourceUris\":[]},\"accessControlSettings\":{\"restrictClients\":false,\"allowedClients\":[]},\"sessionValidationSettings\":{\"checkValidAuthnSession\":false,\"checkSessionRevocationStatus\":false,\"updateAuthnSessionActivity\":false}}]",
        "scopes": [],
        "redirectUrisRequired": true,
        "clientSecretRequired": true,
        "promotedClientIds": {}
      }
    ],
    "currentPage": 0,
    "totalPages": 1,
    "numberPerPage": 10,
    "totalItems": 1
  },
  "errors": null
}