PingOne Platform APIs

Step 17: Token Introspection

 

POST {{authPath}}/{{envID}}/as/introspect

You can use the POST /{{envID}}/as/introspect endpoint operation to examine the token to verify that the aud (audience property) and scope properties specify the new custom resource and custom scope, respectively.

Headers

Authorization

Content-Type      application/x-www-form-urlencoded

Body

urlencoded ( application/x-www-form-urlencoded )

Key Value

token

{{customResourceAccessToken}}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff '{{authPath}}/{{envID}}/as/introspect' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Basic e3tjdXN0b21SZXNvdXJjZUFwcElEfX06e3tjdXN0b21SZXNvdXJjZUFwcFNlY3JldH19' \
--data-urlencode 'token={{customResourceAccessToken}}'
var options = new RestClientOptions("{{authPath}}/{{envID}}/as/introspect")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "application/x-www-form-urlencoded");
request.AddHeader("Authorization", "Basic e3tjdXN0b21SZXNvdXJjZUFwcElEfX06e3tjdXN0b21SZXNvdXJjZUFwcFNlY3JldH19");
request.AddParameter("token", "{{customResourceAccessToken}}");
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
package main

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

func main() {

  url := "{{authPath}}/{{envID}}/as/introspect"
  method := "POST"

  payload := strings.NewReader("token=%7B%7BcustomResourceAccessToken%7D%7D")

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

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/x-www-form-urlencoded")
  req.Header.Add("Authorization", "Basic e3tjdXN0b21SZXNvdXJjZUFwcElEfX06e3tjdXN0b21SZXNvdXJjZUFwcFNlY3JldH19")

  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 /{{envID}}/as/introspect HTTP/1.1
Host: {{authPath}}
Content-Type: application/x-www-form-urlencoded
Authorization: Basic e3tjdXN0b21SZXNvdXJjZUFwcElEfX06e3tjdXN0b21SZXNvdXJjZUFwcFNlY3JldH19

token=%7B%7BcustomResourceAccessToken%7D%7D
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/x-www-form-urlencoded");
RequestBody body = RequestBody.create(mediaType, "token={{customResourceAccessToken}}");
Request request = new Request.Builder()
  .url("{{authPath}}/{{envID}}/as/introspect")
  .method("POST", body)
  .addHeader("Content-Type", "application/x-www-form-urlencoded")
  .addHeader("Authorization", "Basic e3tjdXN0b21SZXNvdXJjZUFwcElEfX06e3tjdXN0b21SZXNvdXJjZUFwcFNlY3JldH19")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{authPath}}/{{envID}}/as/introspect",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/x-www-form-urlencoded",
    "Authorization": "Basic e3tjdXN0b21SZXNvdXJjZUFwcElEfX06e3tjdXN0b21SZXNvdXJjZUFwcFNlY3JldH19"
  },
  "data": {
    "token": "{{customResourceAccessToken}}"
  }
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'POST',
  'url': '{{authPath}}/{{envID}}/as/introspect',
  'headers': {
    'Content-Type': 'application/x-www-form-urlencoded',
    'Authorization': 'Basic e3tjdXN0b21SZXNvdXJjZUFwcElEfX06e3tjdXN0b21SZXNvdXJjZUFwcFNlY3JldH19'
  },
  form: {
    'token': '{{customResourceAccessToken}}'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
import requests

url = "{{authPath}}/{{envID}}/as/introspect"

payload = 'token=%7B%7BcustomResourceAccessToken%7D%7D'
headers = {
  'Content-Type': 'application/x-www-form-urlencoded',
  'Authorization': 'Basic e3tjdXN0b21SZXNvdXJjZUFwcElEfX06e3tjdXN0b21SZXNvdXJjZUFwcFNlY3JldH19'
}

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

print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{authPath}}/{{envID}}/as/introspect');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Content-Type' => 'application/x-www-form-urlencoded',
  'Authorization' => 'Basic e3tjdXN0b21SZXNvdXJjZUFwcElEfX06e3tjdXN0b21SZXNvdXJjZUFwcFNlY3JldH19'
));
$request->addPostParameter(array(
  'token' => '{{customResourceAccessToken}}'
));
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("{{authPath}}/{{envID}}/as/introspect")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/x-www-form-urlencoded"
request["Authorization"] = "Basic e3tjdXN0b21SZXNvdXJjZUFwcElEfX06e3tjdXN0b21SZXNvdXJjZUFwcFNlY3JldH19"
request.body = "token=%7B%7BcustomResourceAccessToken%7D%7D"

response = http.request(request)
puts response.read_body
let parameters = "token=%7B%7BcustomResourceAccessToken%7D%7D"
let postData =  parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "{{authPath}}/{{envID}}/as/introspect")!,timeoutInterval: Double.infinity)
request.addValue("application/x-www-form-urlencoded", forHTTPHeaderField: "Content-Type")
request.addValue("Basic e3tjdXN0b21SZXNvdXJjZUFwcElEfX06e3tjdXN0b21SZXNvdXJjZUFwcFNlY3JldH19", 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

{
    "active": true,
    "scope": "CustomScope_1662666837",
    "client_id": "5d5964d2-2012-4033-a98e-64ef4c45b403",
    "token_type": "Bearer",
    "exp": 1662674267,
    "iat": 1662667067,
    "sub": "cc500f46-ed40-4d61-8b4a-a7d7dcc58c61",
    "aud": [
        "https://api.custom-resource.com"
    ],
    "iss": "https://auth.pingone.com/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/as",
    "sid": "5cfe57b9-cf8c-4191-b8f0-a032b59ace6b"
}