Back to Collection Items
<?php
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.HttpRequest')
$req = new COM("Chilkat.HttpRequest");
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jsonParam1 = new COM("Chilkat.JsonObject");
$req->AddParam('token',$jsonParam1->emit());
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jsonParam2 = new COM("Chilkat.JsonObject");
$req->AddParam('client_id',$jsonParam2->emit());
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jsonParam3 = new COM("Chilkat.JsonObject");
$req->AddParam('client_secret',$jsonParam3->emit());
$req->AddHeader('Authorization','Bearer <access_token>');
// resp is a Chilkat.HttpResponse
$resp = $http->PostUrlEncoded('https://<tenant-name>.forgeblocks.com/am/oauth2/realms/root/realms/alpha/introspect',$req);
if ($http->LastMethodSuccess == 0) {
print $http->LastErrorText . "\n";
exit;
}
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponseBody = new COM("Chilkat.StringBuilder");
$resp->GetBodySb($sbResponseBody);
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jResp = new COM("Chilkat.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $resp->StatusCode;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
print 'Response Header:' . "\n";
print $resp->Header . "\n";
print 'Failed.' . "\n";
exit;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "active": true,
// "scope": "share",
// "realm": "/",
// "client_id": "forgerockDemoConfidentialClient",
// "user_id": "demo",
// "token_type": "Bearer",
// "exp": 1597324460,
// "sub": "demo",
// "iss": "http://openam.example.com:8080/openam/oauth2",
// "auth_level": 0,
// "authGrantId": "HZdG4E4NnNcP6k4T2bCTxPPeysg",
// "auditTrackingId": "037f02f9-d821-4f72-8563-c5050c40fdc3-50979",
// "expires_in": 3600
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
$active = $jResp->BoolOf('active');
$scope = $jResp->stringOf('scope');
$realm = $jResp->stringOf('realm');
$client_id = $jResp->stringOf('client_id');
$user_id = $jResp->stringOf('user_id');
$token_type = $jResp->stringOf('token_type');
$exp = $jResp->IntOf('exp');
$v_sub = $jResp->stringOf('sub');
$iss = $jResp->stringOf('iss');
$auth_level = $jResp->IntOf('auth_level');
$authGrantId = $jResp->stringOf('authGrantId');
$auditTrackingId = $jResp->stringOf('auditTrackingId');
$expires_in = $jResp->IntOf('expires_in');
?>
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
--data-urlencode 'token={{access_token}}'
--data-urlencode 'client_id={{postmanConfidentialClientId}}'
--data-urlencode 'client_secret={{postmanClientSecret}}'
https://<tenant-name>.forgeblocks.com/am/oauth2/realms/root/realms/alpha/introspect
Postman Collection Item JSON
{
"name": "Step 4: Introspect the Access Token",
"event": [
{
"listen": "test",
"script": {
"exec": [
"// Tests",
"",
"const jsonData = JSON.parse(responseBody);",
"",
"pm.test(\"Status code is 200\", () => {",
" pm.expect(pm.response.code).to.eql(200);",
"});",
"",
"pm.test(\"Response contains correct `client_id`.\", function () {",
" pm.expect(jsonData.client_id).to.eql(pm.collectionVariables.get(\"postmanConfidentialClientId\"));",
"});",
"",
"",
""
],
"type": "text/javascript"
}
}
],
"request": {
"method": "POST",
"header": [
],
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"key": "token",
"value": "{{access_token}}",
"description": "Access token you want to introspect.",
"type": "text"
},
{
"key": "client_id",
"value": "{{postmanConfidentialClientId}}",
"description": "The ID of the Confidential OAuth Client.",
"type": "text"
},
{
"key": "client_secret",
"value": "{{postmanClientSecret}}",
"description": "The ID of the Confidential OAuth Client.",
"type": "text"
}
]
},
"url": {
"raw": "{{amUrl}}/oauth2{{realm}}/introspect",
"host": [
"{{amUrl}}"
],
"path": [
"oauth2{{realm}}",
"introspect"
]
},
"description": "Retrieve metadata about the active access token, such as, approved scopes, the user that authorized the token, and the expiry time."
},
"response": [
{
"name": "Example",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"key": "token",
"value": "{{access_token}}",
"description": "Access token you want to introspect.",
"type": "text"
},
{
"key": "client_id",
"value": "{{postmanConfidentialClientId}}",
"description": "The ID of the Confidential OAuth Client.",
"type": "text"
},
{
"key": "client_secret",
"value": "{{postmanClientSecret}}",
"description": "The ID of the Confidential OAuth Client.",
"type": "text"
}
]
},
"url": {
"raw": "{{amUrl}}/oauth2{{realm}}/introspect",
"host": [
"{{amUrl}}"
],
"path": [
"oauth2{{realm}}",
"introspect"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "Content-Type",
"value": "application/json;charset=UTF-8"
},
{
"key": "Content-Length",
"value": "351"
},
{
"key": "Date",
"value": "Thu, 13 Aug 2020 12:14:35 GMT"
}
],
"cookie": [
],
"body": "{\n \"active\": true,\n \"scope\": \"share\",\n \"realm\": \"/\",\n \"client_id\": \"forgerockDemoConfidentialClient\",\n \"user_id\": \"demo\",\n \"token_type\": \"Bearer\",\n \"exp\": 1597324460,\n \"sub\": \"demo\",\n \"iss\": \"http://openam.example.com:8080/openam/oauth2\",\n \"auth_level\": 0,\n \"authGrantId\": \"HZdG4E4NnNcP6k4T2bCTxPPeysg\",\n \"auditTrackingId\": \"037f02f9-d821-4f72-8563-c5050c40fdc3-50979\",\n \"expires_in\": 3600\n}"
}
]
}
