Chilkat Online Tools

Foxpro / ForgeRock Identity Cloud Collection / Step 4: Refresh the Access Token

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loReq
LOCAL loJsonParam2
LOCAL loJsonParam3
LOCAL loJsonParam4
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcAccess_token
LOCAL lcRefresh_token
LOCAL lcScope
LOCAL lcToken_type
LOCAL lnExpires_in

* 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 CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.HttpRequest')
loReq = CreateObject('Chilkat.HttpRequest')
loReq.AddParam("grant_type","refresh_token")

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJsonParam2 = CreateObject('Chilkat.JsonObject')
loReq.AddParam("refresh_token",loJsonParam2.Emit())

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJsonParam3 = CreateObject('Chilkat.JsonObject')
loReq.AddParam("client_id",loJsonParam3.Emit())

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJsonParam4 = CreateObject('Chilkat.JsonObject')
loReq.AddParam("client_secret",loJsonParam4.Emit())
loReq.AddParam("scope","edit")

loReq.AddHeader("Authorization","Bearer <access_token>")

loResp = loHttp.PostUrlEncoded("https://<tenant-name>.forgeblocks.com/am/oauth2/realms/root/realms/alpha/access_token",loReq)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loReq
    RELEASE loJsonParam2
    RELEASE loJsonParam3
    RELEASE loJsonParam4
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    RELEASE loResp
    RELEASE loHttp
    RELEASE loReq
    RELEASE loJsonParam2
    RELEASE loJsonParam3
    RELEASE loJsonParam4
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

RELEASE loResp

* Sample JSON response:
* (Sample code for parsing the JSON response is shown below)

* {
*   "access_token": "eyJ0eXAiOiJKV1.cyI6Imh0dHA6Ly9vcGVuYW0uZ",
*   "refresh_token": "eyJ0CJhbGciOiJ.NzgxNCIsImlzcyI6Imh0dH",
*   "scope": "edit",
*   "token_type": "Bearer",
*   "expires_in": 3599
* }

* Sample code for parsing the JSON response...
* Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

lcAccess_token = loJResp.StringOf("access_token")
lcRefresh_token = loJResp.StringOf("refresh_token")
lcScope = loJResp.StringOf("scope")
lcToken_type = loJResp.StringOf("token_type")
lnExpires_in = loJResp.IntOf("expires_in")

RELEASE loHttp
RELEASE loReq
RELEASE loJsonParam2
RELEASE loJsonParam3
RELEASE loJsonParam4
RELEASE loSbResponseBody
RELEASE loJResp

Curl Command

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

Postman Collection Item JSON

{
  "name": "Step 4: Refresh the Access Token",
  "event": [
    {
      "listen": "prerequest",
      "script": {
        "exec": [
          ""
        ],
        "type": "text/javascript"
      }
    },
    {
      "listen": "test",
      "script": {
        "exec": [
          "var jsonData = JSON.parse(responseBody);",
          "",
          "pm.test(\"Response contains new refresh_token\", function () {",
          "    pm.expect(jsonData.refresh_token).to.not.eql(pm.globals.get(\"refresh_token\"));",
          "});",
          "",
          "pm.test(\"Response contains new access_token\", function () {",
          "    pm.expect(jsonData.access_token).to.not.eql(pm.globals.get(\"access_token\"));",
          "});",
          "",
          "",
          "",
          "if(jsonData.access_token && jsonData.access_token != \"\" && jsonData.access_token != pm.globals.get(\"access_token\"))",
          "{",
          "    pm.globals.set(\"access_token\", jsonData.access_token);",
          "}",
          "",
          "if(jsonData.refresh_token && jsonData.refresh_token != \"\" && jsonData.refresh_token != pm.globals.get(\"refresh_token\"))",
          "{",
          "    pm.globals.set(\"refresh_token\", jsonData.refresh_token);",
          "}",
          "",
          "// Tests",
          "",
          "pm.test(\"Status code is 200\", () => {",
          "  pm.expect(pm.response.code).to.eql(200);",
          "});",
          "",
          "pm.test(\"Response contains access_token\", function () {",
          "    pm.expect(jsonData.access_token).to.be.a(\"string\");",
          "});",
          "",
          "pm.test(\"Response contains refresh_token\", function () {",
          "    pm.expect(jsonData.refresh_token).to.be.a(\"string\");",
          "});",
          "",
          "",
          "",
          ""
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "urlencoded",
      "urlencoded": [
        {
          "key": "grant_type",
          "value": "refresh_token",
          "description": "The Grant Type supported by AM.",
          "type": "text"
        },
        {
          "key": "refresh_token",
          "value": "{{refresh_token}}",
          "description": "The refresh token.",
          "type": "text"
        },
        {
          "key": "client_id",
          "value": "{{postmanConfidentialClientId}}",
          "description": "The ID of the OAuth Confidential Client.",
          "type": "text"
        },
        {
          "key": "client_secret",
          "value": "{{postmanClientSecret}}",
          "description": "The secret of the OAuth Confidential Client. See the ForgeRock documentation for stronger methods of client authentication.",
          "type": "text"
        },
        {
          "key": "scope",
          "value": "edit",
          "type": "text"
        }
      ]
    },
    "url": {
      "raw": "{{amUrl}}/oauth2{{realm}}/access_token",
      "host": [
        "{{amUrl}}"
      ],
      "path": [
        "oauth2{{realm}}",
        "access_token"
      ]
    },
    "description": "Use a refresh token to ask for a new access token."
  },
  "response": [
    {
      "name": "Example - new access and refresh tokens",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "urlencoded",
          "urlencoded": [
            {
              "key": "grant_type",
              "value": "refresh_token",
              "description": "The Grant Type supported by AM.",
              "type": "text"
            },
            {
              "key": "refresh_token",
              "value": "{{refresh_token}}",
              "description": "The refresh token.",
              "type": "text"
            },
            {
              "key": "client_id",
              "value": "{{postmanConfidentialClientId}}",
              "description": "The ID of the OAuth Confidential Client.",
              "type": "text"
            },
            {
              "key": "client_secret",
              "value": "{{postmanClientSecret}}",
              "description": "The secret of the OAuth Confidential Client. See the ForgeRock documentation for stronger methods of client authentication.",
              "type": "text"
            },
            {
              "key": "scope",
              "value": "edit",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{amUrl}}/oauth2{{realm}}/access_token",
          "host": [
            "{{amUrl}}"
          ],
          "path": [
            "oauth2{{realm}}",
            "access_token"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "X-Frame-Options",
          "value": "SAMEORIGIN"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "Cache-Control",
          "value": "no-store"
        },
        {
          "key": "Pragma",
          "value": "no-cache"
        },
        {
          "key": "Content-Type",
          "value": "application/json;charset=UTF-8"
        },
        {
          "key": "Content-Length",
          "value": "1627"
        },
        {
          "key": "Date",
          "value": "Thu, 13 Aug 2020 12:21:50 GMT"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"access_token\": \"eyJ0eXAiOiJKV1.cyI6Imh0dHA6Ly9vcGVuYW0uZ\",\n    \"refresh_token\": \"eyJ0CJhbGciOiJ.NzgxNCIsImlzcyI6Imh0dH\",\n    \"scope\": \"edit\",\n    \"token_type\": \"Bearer\",\n    \"expires_in\": 3599\n}"
    }
  ]
}