Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_Req
oleobject loo_JsonParam1
oleobject loo_JsonParam2
oleobject loo_JsonParam3
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
integer li_Active
string ls_Scope
string ls_Realm
string ls_Client_id
string ls_User_id
string ls_Token_type
integer li_Exp
string ls_V_sub
string ls_Iss
integer li_Auth_level
string ls_AuthGrantId
string ls_AuditTrackingId
integer li_Expires_in
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_Req = create oleobject
// Use "Chilkat_9_5_0.HttpRequest" for versions of Chilkat < 10.0.0
li_rc = loo_Req.ConnectToNewObject("Chilkat.HttpRequest")
loo_JsonParam1 = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JsonParam1.ConnectToNewObject("Chilkat.JsonObject")
loo_Req.AddParam("token",loo_JsonParam1.Emit())
loo_JsonParam2 = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JsonParam2.ConnectToNewObject("Chilkat.JsonObject")
loo_Req.AddParam("client_id",loo_JsonParam2.Emit())
loo_JsonParam3 = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JsonParam3.ConnectToNewObject("Chilkat.JsonObject")
loo_Req.AddParam("client_secret",loo_JsonParam3.Emit())
loo_Req.AddHeader("Authorization","Bearer <access_token>")
loo_Resp = loo_Http.PostUrlEncoded("https://<tenant-name>.forgeblocks.com/am/oauth2/realms/root/realms/alpha/introspect",loo_Req)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_Req
destroy loo_JsonParam1
destroy loo_JsonParam2
destroy loo_JsonParam3
return
end if
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_Req
destroy loo_JsonParam1
destroy loo_JsonParam2
destroy loo_JsonParam3
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_Resp
// 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
li_Active = loo_JResp.BoolOf("active")
ls_Scope = loo_JResp.StringOf("scope")
ls_Realm = loo_JResp.StringOf("realm")
ls_Client_id = loo_JResp.StringOf("client_id")
ls_User_id = loo_JResp.StringOf("user_id")
ls_Token_type = loo_JResp.StringOf("token_type")
li_Exp = loo_JResp.IntOf("exp")
ls_V_sub = loo_JResp.StringOf("sub")
ls_Iss = loo_JResp.StringOf("iss")
li_Auth_level = loo_JResp.IntOf("auth_level")
ls_AuthGrantId = loo_JResp.StringOf("authGrantId")
ls_AuditTrackingId = loo_JResp.StringOf("auditTrackingId")
li_Expires_in = loo_JResp.IntOf("expires_in")
destroy loo_Http
destroy loo_Req
destroy loo_JsonParam1
destroy loo_JsonParam2
destroy loo_JsonParam3
destroy loo_SbResponseBody
destroy loo_JResp
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}"
}
]
}
