Chilkat Online Tools

VB6 / ForgeRock Identity Cloud Collection / Step 2: Get User Code and Device Code

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
req.AddParam "response_type","device_code"

Dim jsonParam2 As New ChilkatJsonObject
req.AddParam "client_id",jsonParam2.Emit()
req.AddParam "scope","manage"
req.AddParam "code_challenge_method","S256"

Dim jsonParam5 As New ChilkatJsonObject
req.AddParam "code_challenge",jsonParam5.Emit()

req.AddHeader "Authorization","Bearer <access_token>"

Dim resp As ChilkatHttpResponse
Set resp = http.PostUrlEncoded("https://<tenant-name>.forgeblocks.com/am/oauth2/realms/root/realms/alpha/device/code",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)

' {
'   "user_code": "x3W2JEFJ",
'   "device_code": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdWQiOiJodHRwOi8vb3BlbmFtLmV4YW1wbGUuY29tOjgwODAvb3BlbmFtL29hdXRoMiIsIm5iZiI6MTU5NzMyMTE0OCwidXNlcl9jb2RlIjoieDNXMkpFRkoiLCJpc3MiOiJodHRwOi8vb3BlbmFtLmV4YW1wbGUuY29tOjgwODAvb3BlbmFtL29hdXRoMiIsImV4cCI6MTU5NzMyMTQ0OCwiaWF0IjoxNTk3MzIxMTQ4LCJqdGkiOiIxYWI0MTE5Yy0yYjE4LTQxYWYtYjZjMC1iNTRmZTQxZWZhNjEifQ.gCoWICyPwJhD7LshgpfLpc9zEt6iUrsjmbGv6yk2kW0",
'   "interval": 5,
'   "verification_uri": "http://openam.example.com:8080/openam/oauth2/device/user",
'   "expires_in": 300,
'   "verification_url": "http://openam.example.com:8080/openam/oauth2/device/user"
' }

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

Dim user_code As String
user_code = jResp.StringOf("user_code")
Dim device_code As String
device_code = jResp.StringOf("device_code")
Dim interval As Long
interval = jResp.IntOf("interval")
Dim verification_uri As String
verification_uri = jResp.StringOf("verification_uri")
Dim expires_in As Long
expires_in = jResp.IntOf("expires_in")
Dim verification_url As String
verification_url = jResp.StringOf("verification_url")

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	--data-urlencode 'response_type=device_code'
	--data-urlencode 'client_id={{postmanPublicClientId}}'
	--data-urlencode 'scope=manage'
	--data-urlencode 'code_challenge_method=S256'
	--data-urlencode 'code_challenge={{code_challenge}}'
https://<tenant-name>.forgeblocks.com/am/oauth2/realms/root/realms/alpha/device/code

Postman Collection Item JSON

{
  "name": "Step 2: Get User Code and Device Code",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "const jsonData = pm.response.json();",
          "",
          "if(pm.response.code == 200)",
          "{",
          "    if(jsonData.user_code && jsonData.user_code != \"\") {",
          "        pm.globals.set(\"user_code\", jsonData.user_code);",
          "    }",
          "",
          "        if(jsonData.device_code && jsonData.device_code != \"\") {",
          "        pm.globals.set(\"device_code\", jsonData.device_code);",
          "    }",
          "}",
          "",
          "// Tests",
          "",
          "pm.test(\"Status code is 200\", () => {",
          "  pm.expect(pm.response.code).to.eql(200);",
          "});",
          "",
          "pm.test(\"Response contains `user_code`.\", function () {",
          "    pm.expect(jsonData.user_code).to.be.a(\"string\");",
          "});",
          "",
          "pm.test(\"Response contains `device_code`.\", function () {",
          "    pm.expect(jsonData.device_code).to.be.a(\"string\");",
          "});"
        ],
        "type": "text/javascript"
      }
    },
    {
      "listen": "prerequest",
      "script": {
        "exec": [
          "function base64URLEncode(words) {",
          "   return CryptoJS.enc.Base64.stringify(words)",
          "   .replace(/\\+/g, '-')",
          "   .replace(/\\//g, '_')",
          "   .replace(/=/g, '');",
          "}",
          "const code_verifier = base64URLEncode(CryptoJS.lib.WordArray.random(50));",
          "const code_challenge = base64URLEncode(CryptoJS.SHA256(code_verifier));",
          "",
          "pm.globals.set(\"code_challenge\", code_challenge);",
          "pm.globals.set(\"code_verifier\", code_verifier);"
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "urlencoded",
      "urlencoded": [
        {
          "key": "response_type",
          "value": "device_code",
          "description": "Response types this client will support and use.",
          "type": "text"
        },
        {
          "key": "client_id",
          "value": "{{postmanPublicClientId}}",
          "description": "The ID of the Confidential OAuth Client.",
          "type": "text"
        },
        {
          "key": "scope",
          "value": "manage",
          "description": "Strings that are presented to the user for approval and included in tokens so that the protected resource may make decisions about what to give access to.",
          "type": "text"
        },
        {
          "key": "code_challenge_method",
          "value": "S256",
          "description": "The method used to generate the code challenge.",
          "type": "text"
        },
        {
          "key": "code_challenge",
          "value": "{{code_challenge}}",
          "description": "The generated code challenge.",
          "type": "text"
        }
      ]
    },
    "url": {
      "raw": "{{amUrl}}/oauth2{{realm}}/device/code",
      "host": [
        "{{amUrl}}"
      ],
      "path": [
        "oauth2{{realm}}",
        "device",
        "code"
      ]
    },
    "description": "Receive a user code and a device code, which can be used to provide consent.\n\n\n\n"
  },
  "response": [
    {
      "name": "Example",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "urlencoded",
          "urlencoded": [
            {
              "key": "response_type",
              "value": "device_code",
              "description": "Response types this client will support and use.",
              "type": "text"
            },
            {
              "key": "client_id",
              "value": "{{postmanPublicClientId}}",
              "description": "The ID of the Confidential OAuth Client.",
              "type": "text"
            },
            {
              "key": "scope",
              "value": "manage",
              "description": "Strings that are presented to the user for approval and included in tokens so that the protected resource may make decisions about what to give access to.",
              "type": "text"
            },
            {
              "key": "code_challenge_method",
              "value": "S256",
              "description": "The method used to generate the code challenge.",
              "type": "text"
            },
            {
              "key": "code_challenge",
              "value": "{{code_challenge}}",
              "description": "The generated code challenge.",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{amUrl}}/oauth2{{realm}}/device/code",
          "host": [
            "{{amUrl}}"
          ],
          "path": [
            "oauth2{{realm}}",
            "device",
            "code"
          ]
        }
      },
      "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": "610"
        },
        {
          "key": "Date",
          "value": "Thu, 13 Aug 2020 12:19:08 GMT"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"user_code\": \"x3W2JEFJ\",\n    \"device_code\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdWQiOiJodHRwOi8vb3BlbmFtLmV4YW1wbGUuY29tOjgwODAvb3BlbmFtL29hdXRoMiIsIm5iZiI6MTU5NzMyMTE0OCwidXNlcl9jb2RlIjoieDNXMkpFRkoiLCJpc3MiOiJodHRwOi8vb3BlbmFtLmV4YW1wbGUuY29tOjgwODAvb3BlbmFtL29hdXRoMiIsImV4cCI6MTU5NzMyMTQ0OCwiaWF0IjoxNTk3MzIxMTQ4LCJqdGkiOiIxYWI0MTE5Yy0yYjE4LTQxYWYtYjZjMC1iNTRmZTQxZWZhNjEifQ.gCoWICyPwJhD7LshgpfLpc9zEt6iUrsjmbGv6yk2kW0\",\n    \"interval\": 5,\n    \"verification_uri\": \"http://openam.example.com:8080/openam/oauth2/device/user\",\n    \"expires_in\": 300,\n    \"verification_url\": \"http://openam.example.com:8080/openam/oauth2/device/user\"\n}"
    }
  ]
}