Chilkat Online Tools

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

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("response_type", value: "device_code")

    let jsonParam2 = CkoJsonObject()
    req.AddParam("client_id", value: jsonParam2.Emit())
    req.AddParam("scope", value: "write")

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

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

    // {
    //   "user_code": "KNpesLcE",
    //   "device_code": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdWQiOiJodHRwOi8vb3BlbmFtLmV4YW1wbGUuY29tOjgwODAvb3BlbmFtL29hdXRoMiIsIm5iZiI6MTU5NzMyMTA2NSwidXNlcl9jb2RlIjoiS05wZXNMY0UiLCJpc3MiOiJodHRwOi8vb3BlbmFtLmV4YW1wbGUuY29tOjgwODAvb3BlbmFtL29hdXRoMiIsImV4cCI6MTU5NzMyMTM2NSwiaWF0IjoxNTk3MzIxMDY1LCJqdGkiOiJmNGM1NDFlYS0wZmQ3LTQzN2YtYjY2Zi0zMGJlZGY2MDU0YzEifQ.ykCohgneHtyxy4MYkP8CrwTQpSp4fpZrulOW7xKXWEk",
    //   "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

    var user_code: String? = jResp.StringOf("user_code")
    var device_code: String? = jResp.StringOf("device_code")
    var interval: Int = jResp.IntOf("interval").intValue
    var verification_uri: String? = jResp.StringOf("verification_uri")
    var expires_in: Int = jResp.IntOf("expires_in").intValue
    var verification_url: String? = 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=write'
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"
      }
    }
  ],
  "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 public OAuth Client.",
          "type": "text"
        },
        {
          "key": "scope",
          "value": "write",
          "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"
        }
      ]
    },
    "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"
  },
  "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 public OAuth Client.",
              "type": "text"
            },
            {
              "key": "scope",
              "value": "write",
              "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"
            }
          ]
        },
        "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:17:45 GMT"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"user_code\": \"KNpesLcE\",\n    \"device_code\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdWQiOiJodHRwOi8vb3BlbmFtLmV4YW1wbGUuY29tOjgwODAvb3BlbmFtL29hdXRoMiIsIm5iZiI6MTU5NzMyMTA2NSwidXNlcl9jb2RlIjoiS05wZXNMY0UiLCJpc3MiOiJodHRwOi8vb3BlbmFtLmV4YW1wbGUuY29tOjgwODAvb3BlbmFtL29hdXRoMiIsImV4cCI6MTU5NzMyMTM2NSwiaWF0IjoxNTk3MzIxMDY1LCJqdGkiOiJmNGM1NDFlYS0wZmQ3LTQzN2YtYjY2Zi0zMGJlZGY2MDU0YzEifQ.ykCohgneHtyxy4MYkP8CrwTQpSp4fpZrulOW7xKXWEk\",\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}"
    }
  ]
}