Chilkat Online Tools

TCL / ForgeRock Identity Cloud Collection / Step 5: Revoke the Refresh Token

Back to Collection Items

load ./chilkat.dll

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

set http [new_CkHttp]

set req [new_CkHttpRequest]

set jsonParam1 [new_CkJsonObject]

CkHttpRequest_AddParam $req "token" [CkJsonObject_emit $jsonParam1]

set jsonParam2 [new_CkJsonObject]

CkHttpRequest_AddParam $req "client_id" [CkJsonObject_emit $jsonParam2]

set jsonParam3 [new_CkJsonObject]

CkHttpRequest_AddParam $req "client_secret" [CkJsonObject_emit $jsonParam3]

CkHttpRequest_AddHeader $req "Authorization" "Bearer <access_token>"

# resp is a CkHttpResponse
set resp [CkHttp_PostUrlEncoded $http "https://<tenant-name>.forgeblocks.com/am/oauth2/realms/root/realms/alpha/token/revoke" $req]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkHttpRequest $req
    delete_CkJsonObject $jsonParam1
    delete_CkJsonObject $jsonParam2
    delete_CkJsonObject $jsonParam3
    exit
}

set sbResponseBody [new_CkStringBuilder]

CkHttpResponse_GetBodySb $resp $sbResponseBody

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttpResponse_header $resp]
    puts "Failed."
    delete_CkHttpResponse $resp

    delete_CkHttp $http
    delete_CkHttpRequest $req
    delete_CkJsonObject $jsonParam1
    delete_CkJsonObject $jsonParam2
    delete_CkJsonObject $jsonParam3
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

delete_CkHttpResponse $resp


delete_CkHttp $http
delete_CkHttpRequest $req
delete_CkJsonObject $jsonParam1
delete_CkJsonObject $jsonParam2
delete_CkJsonObject $jsonParam3
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	--data-urlencode 'token={{refresh_token}}'
	--data-urlencode 'client_id={{postmanConfidentialClientId}}'
	--data-urlencode 'client_secret={{postmanClientSecret}}'
https://<tenant-name>.forgeblocks.com/am/oauth2/realms/root/realms/alpha/token/revoke

Postman Collection Item JSON

{
  "name": "Step 5: Revoke the Refresh Token ",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "// Tests",
          "",
          "pm.test(\"Status code is 200\", () => {",
          "  pm.expect(pm.response.code).to.eql(200);",
          "});",
          "",
          "pm.test(\"Response JSON is empty\", function () {",
          "    pm.expect(responseBody.length).to.eql(2);",
          "});"
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "urlencoded",
      "urlencoded": [
        {
          "key": "token",
          "value": "{{refresh_token}}",
          "description": "The refresh token to revoke.",
          "type": "text"
        },
        {
          "key": "client_id",
          "value": "{{postmanConfidentialClientId}}",
          "description": "The ID of the Confidential OAuth Client. ",
          "type": "text"
        },
        {
          "key": "client_secret",
          "value": "{{postmanClientSecret}}",
          "description": "The secret of the Confidential OAuth Client. See the ForgeRock documentation for stronger methods of client authentication.",
          "type": "text"
        }
      ]
    },
    "url": {
      "raw": "{{amUrl}}/oauth2{{realm}}/token/revoke",
      "host": [
        "{{amUrl}}"
      ],
      "path": [
        "oauth2{{realm}}",
        "token",
        "revoke"
      ]
    },
    "description": "Revoke the refresh token created in the previous call. Revoking a refresh token also revokes any other associated tokens that were issued with the same authorization grant. "
  },
  "response": [
    {
      "name": "Example - Empty response when revoking a token.",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "urlencoded",
          "urlencoded": [
            {
              "key": "token",
              "value": "{{refresh_token}}",
              "description": "The refresh token to revoke.",
              "type": "text"
            },
            {
              "key": "client_id",
              "value": "{{postmanConfidentialClientId}}",
              "description": "The ID of the Confidential OAuth Client. ",
              "type": "text"
            },
            {
              "key": "client_secret",
              "value": "{{postmanClientSecret}}",
              "description": "The secret of the Confidential OAuth Client. See the ForgeRock documentation for stronger methods of client authentication.",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{amUrl}}/oauth2{{realm}}/token/revoke",
          "host": [
            "{{amUrl}}"
          ],
          "path": [
            "oauth2{{realm}}",
            "token",
            "revoke"
          ]
        }
      },
      "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": "2"
        },
        {
          "key": "Date",
          "value": "Thu, 13 Aug 2020 12:22:07 GMT"
        }
      ],
      "cookie": [
      ],
      "body": "{}"
    }
  ]
}