Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
$oReq = ObjCreate("Chilkat.HttpRequest")
$oJsonParam1 = ObjCreate("Chilkat.JsonObject")
$oReq.AddParam "token",$oJsonParam1.Emit()
$oJsonParam2 = ObjCreate("Chilkat.JsonObject")
$oReq.AddParam "client_id",$oJsonParam2.Emit()
$oJsonParam3 = ObjCreate("Chilkat.JsonObject")
$oReq.AddParam "client_secret",$oJsonParam3.Emit()
$oReq.AddHeader "Authorization","Bearer <access_token>"
Local $oResp = $oHttp.PostUrlEncoded("https://<tenant-name>.forgeblocks.com/am/oauth2/realms/root/realms/alpha/introspect",$oReq)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "active": true,
; "scope": "write",
; "realm": "/",
; "client_id": "forgerockDemoConfidentialClient",
; "user_id": "demo",
; "token_type": "Bearer",
; "exp": 1597324266,
; "sub": "demo",
; "iss": "http://openam.example.com:8080/openam/oauth2",
; "auth_level": 0,
; "authGrantId": "KrTzIkhIQNqgkrcQBIoGu57eNFE",
; "auditTrackingId": "037f02f9-d821-4f72-8563-c5050c40fdc3-49716",
; "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
Local $bActive = $oJResp.BoolOf("active")
Local $scope = $oJResp.StringOf("scope")
Local $sRealm = $oJResp.StringOf("realm")
Local $sClient_id = $oJResp.StringOf("client_id")
Local $sUser_id = $oJResp.StringOf("user_id")
Local $sToken_type = $oJResp.StringOf("token_type")
Local $iExp = $oJResp.IntOf("exp")
Local $sV_sub = $oJResp.StringOf("sub")
Local $sIss = $oJResp.StringOf("iss")
Local $iAuth_level = $oJResp.IntOf("auth_level")
Local $sAuthGrantId = $oJResp.StringOf("authGrantId")
Local $sAuditTrackingId = $oJResp.StringOf("auditTrackingId")
Local $iExpires_in = $oJResp.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:13:22 GMT"
}
],
"cookie": [
],
"body": "{\n \"active\": true,\n \"scope\": \"write\",\n \"realm\": \"/\",\n \"client_id\": \"forgerockDemoConfidentialClient\",\n \"user_id\": \"demo\",\n \"token_type\": \"Bearer\",\n \"exp\": 1597324266,\n \"sub\": \"demo\",\n \"iss\": \"http://openam.example.com:8080/openam/oauth2\",\n \"auth_level\": 0,\n \"authGrantId\": \"KrTzIkhIQNqgkrcQBIoGu57eNFE\",\n \"auditTrackingId\": \"037f02f9-d821-4f72-8563-c5050c40fdc3-49716\",\n \"expires_in\": 3600\n}"
}
]
}
