Chilkat Online Tools

VB6 / ForgeRock Identity Cloud Collection / Step 4: Poll for Authorization

Back to Collection Items

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

Dim http As New ChilkatHttp
Dim success As Long

Dim req As New ChilkatHttpRequest

Dim jsonParam1 As New ChilkatJsonObject
req.AddParam "client_id",jsonParam1.Emit()
req.AddParam "grant_type","http://oauth.net/grant_type/device/1.0"

Dim jsonParam3 As New ChilkatJsonObject
req.AddParam "code",jsonParam3.Emit()

Dim jsonParam4 As New ChilkatJsonObject
req.AddParam "code_verifier",jsonParam4.Emit()

Dim resp As ChilkatHttpResponse
Set resp = http.PostUrlEncoded("https://<tenant-name>.forgeblocks.com/am/oauth2/realms/root/realms/alpha/access_token",req)
If (http.LastMethodSuccess = 0) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Dim sbResponseBody As New ChilkatStringBuilder
success = resp.GetBodySb(sbResponseBody)

Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0

Debug.Print "Response Body:"
Debug.Print jResp.Emit()

Dim respStatusCode As Long
respStatusCode = resp.StatusCode
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
    Debug.Print "Response Header:"
    Debug.Print resp.Header
    Debug.Print "Failed."

    Exit Sub
End If

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

' {
'   "access_token": "eyJ0eXAiJ9.eyJzdWIiOiJkZPXXcM",
'   "refresh_token": "eyJ0eXAiOiJKV1QiLC.eyl0VHJXpdhFiWDw",
'   "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

Dim access_token As String
access_token = jResp.StringOf("access_token")
Dim refresh_token As String
refresh_token = jResp.StringOf("refresh_token")
Dim token_type As String
token_type = jResp.StringOf("token_type")
Dim expires_in As Long
expires_in = jResp.IntOf("expires_in")

Curl Command

curl -X POST
	--data-urlencode 'client_id={{postmanPublicClientId}}'
	--data-urlencode 'grant_type=http://oauth.net/grant_type/device/1.0'
	--data-urlencode 'code={{device_code}}'
	--data-urlencode 'code_verifier={{code_verifier}}'
https://<tenant-name>.forgeblocks.com/am/oauth2/realms/root/realms/alpha/access_token

Postman Collection Item JSON

{
  "name": "Step 4: Poll for Authorization",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "var jsonData = JSON.parse(responseBody);",
          "",
          "if(jsonData.access_token && jsonData.access_token != \"\")",
          "{",
          "    pm.globals.set(\"access_token\", jsonData.access_token);",
          "}",
          "",
          "if(jsonData.refresh_token && jsonData.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(\"Status code is not 400 - Polling too Quickly\", () => {",
          "  // The polling interval has not elapsed since the last request.  ",
          "  pm.expect(pm.response.code).to.not.eql(400);",
          "});",
          "",
          "pm.test(\"Status code is not 401 - Token not valid\", () => {",
          "  // The request contains a token no longer valid.  ",
          "  pm.expect(pm.response.code).to.not.eql(401);",
          "});",
          "",
          "pm.test(\"Response contains access_token\", function () {",
          "    pm.expect(jsonData.access_token).to.be.a(\"string\");",
          "});",
          "",
          ""
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "auth": {
      "type": "noauth"
    },
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "urlencoded",
      "urlencoded": [
        {
          "key": "client_id",
          "value": "{{postmanPublicClientId}}",
          "description": "The ID of the Confidential OAuth Client.",
          "type": "text"
        },
        {
          "key": "grant_type",
          "value": "http://oauth.net/grant_type/device/1.0",
          "description": "Grant types this client will support and use.",
          "type": "text"
        },
        {
          "key": "code",
          "value": "{{device_code}}",
          "description": "The device code for the device.",
          "type": "text"
        },
        {
          "key": "code_verifier",
          "value": "{{code_verifier}}",
          "description": "The generated code verifier. See the Pre-request script in the previous step.",
          "type": "text"
        }
      ]
    },
    "url": {
      "raw": "{{amUrl}}/oauth2{{realm}}/access_token",
      "host": [
        "{{amUrl}}"
      ],
      "path": [
        "oauth2{{realm}}",
        "access_token"
      ]
    },
    "description": "Poll the authorization server for an access token, to find out whether the resource owner has already given consent or not."
  },
  "response": [
    {
      "name": "Example",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "urlencoded",
          "urlencoded": [
            {
              "key": "client_id",
              "value": "{{postmanPublicClientId}}",
              "description": "The ID of the Confidential OAuth Client.",
              "type": "text"
            },
            {
              "key": "grant_type",
              "value": "http://oauth.net/grant_type/device/1.0",
              "description": "Grant types this client will support and use.",
              "type": "text"
            },
            {
              "key": "code",
              "value": "{{device_code}}",
              "description": "The device code for the device.",
              "type": "text"
            },
            {
              "key": "code_verifier",
              "value": "{{code_verifier}}",
              "description": "The generated code verifier. See the Pre-request script in the previous step.",
              "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": "1620"
        },
        {
          "key": "Date",
          "value": "Thu, 13 Aug 2020 12:19:44 GMT"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"access_token\": \"eyJ0eXAiJ9.eyJzdWIiOiJkZPXXcM\",\n    \"refresh_token\": \"eyJ0eXAiOiJKV1QiLC.eyl0VHJXpdhFiWDw\",\n    \"token_type\": \"Bearer\",\n    \"expires_in\": 3599\n}"
    },
    {
      "name": "Example - polling too quickly",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "urlencoded",
          "urlencoded": [
            {
              "key": "client_id",
              "value": "{{postmanPublicClientId}}",
              "description": "The ID of the Confidential OAuth Client.",
              "type": "text"
            },
            {
              "key": "grant_type",
              "value": "http://oauth.net/grant_type/device/1.0",
              "description": "Grant types this client will support and use.",
              "type": "text"
            },
            {
              "key": "code",
              "value": "{{device_code}}",
              "description": "The device code for the device.",
              "type": "text"
            },
            {
              "key": "code_verifier",
              "value": "{{code_verifier}}",
              "description": "The generated code verifier. See the Pre-request script in the previous step.",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{amUrl}}/oauth2{{realm}}/access_token",
          "host": [
            "{{amUrl}}"
          ],
          "path": [
            "oauth2{{realm}}",
            "access_token"
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_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": "103"
        },
        {
          "key": "Date",
          "value": "Thu, 13 Aug 2020 12:20:00 GMT"
        },
        {
          "key": "Connection",
          "value": "close"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"error_description\": \"The polling interval has not elapsed since the last request\",\n    \"error\": \"slow_down\"\n}"
    }
  ]
}