Chilkat Online Tools

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

Back to Collection Items

func chilkatTest() {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    let http = CkoHttp()!
    var success: Bool

    let req = CkoHttpRequest()!
    req.addParam("grant_type", value: "refresh_token")

    let jsonParam2 = CkoJsonObject()!
    req.addParam("refresh_token", value: jsonParam2.emit())

    let jsonParam3 = CkoJsonObject()!
    req.addParam("client_id", value: jsonParam3.emit())

    let jsonParam4 = CkoJsonObject()!
    req.addParam("client_secret", value: jsonParam4.emit())
    req.addParam("scope", value: "edit")

    req.addHeader("Authorization", value: "Bearer <access_token>")

    var resp: CkoHttpResponse? = http.postUrlEncoded("https://<tenant-name>.forgeblocks.com/am/oauth2/realms/root/realms/alpha/access_token", req: req)
    if http.lastMethodSuccess == false {
        print("\(http.lastErrorText!)")
        return
    }

    let sbResponseBody = CkoStringBuilder()!
    resp!.getBodySb(sbResponseBody)

    let jResp = CkoJsonObject()!
    jResp.loadSb(sbResponseBody)
    jResp.emitCompact = false

    print("Response Body:")
    print("\(jResp.emit()!)")

    var respStatusCode: Int = resp!.statusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.header!)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

    // 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

    var access_token: String? = jResp.string(of: "access_token")
    var refresh_token: String? = jResp.string(of: "refresh_token")
    var scope: String? = jResp.string(of: "scope")
    var token_type: String? = jResp.string(of: "token_type")
    var expires_in: Int = jResp.int(of: "expires_in").intValue

}

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}"
    }
  ]
}