Chilkat Online Tools

Ruby / Salesforce Platform APIs / Device Flow 1

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

req = Chilkat::CkHttpRequest.new()
req.put_HttpVerb("POST")
req.put_Path("/services/oauth2/token")
req.put_ContentType("multipart/form-data")
req.AddParam("response_type","device_code")

req.AddParam("client_id","device_code{{clientId}}")

req.AddParam("format","device_code{{clientId}}json")

req.AddParam("scope","device_code{{clientId}}jsonfull refresh_token")

# resp is a CkHttpResponse
resp = http.SynchronousRequest("login.salesforce.com{{site}}",443,true,req)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
end

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

# {
#   "user_code": "<user_code>",
#   "device_code": "<device_code",
#   "interval": integer,
#   "verification_uri": "https://<my_domain>/setup/connect"
# }

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

user_code = jResp.stringOf("user_code")
device_code = jResp.stringOf("device_code")
interval = jResp.IntOf("interval")
verification_uri = jResp.stringOf("verification_uri")

Curl Command

curl -X POST
	--form 'response_type=device_code'
	--form 'client_id=device_code{{clientId}}'
	--form 'format=device_code{{clientId}}json'
	--form 'scope=device_code{{clientId}}jsonfull refresh_token'
https://login.salesforce.com{{site}}/services/oauth2/token

Postman Collection Item JSON

{
  "name": "Device Flow 1",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "const jsonData = pm.response.json();",
          "const context = pm.environment.name ? pm.environment : pm.collectionVariables;",
          "context.set(\"_deviceCode\", jsonData.device_code);",
          ""
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "auth": {
      "type": "noauth"
    },
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "formdata",
      "formdata": [
        {
          "key": "response_type",
          "value": "device_code",
          "type": "text"
        },
        {
          "key": "client_id",
          "value": "{{clientId}}",
          "type": "text"
        },
        {
          "key": "format",
          "value": "json",
          "type": "text"
        },
        {
          "key": "scope",
          "value": "full refresh_token",
          "type": "text"
        }
      ]
    },
    "url": {
      "raw": "{{url}}{{site}}/services/oauth2/token",
      "host": [
        "{{url}}{{site}}"
      ],
      "path": [
        "services",
        "oauth2",
        "token"
      ]
    }
  },
  "response": [
    {
      "name": "Successful Device Flow 1",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "response_type",
              "value": "device_code",
              "type": "text"
            },
            {
              "key": "client_id",
              "value": "{{clientId}}",
              "type": "text"
            },
            {
              "key": "format",
              "value": "json",
              "type": "text"
            },
            {
              "key": "scope",
              "value": "full refresh_token",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{url}}{{site}}/services/oauth2/token",
          "host": [
            "{{url}}{{site}}"
          ],
          "path": [
            "services",
            "oauth2",
            "token"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Thu, 16 Nov 2023 15:29:39 GMT"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=63072000; includeSubDomains"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "X-XSS-Protection",
          "value": "1; mode=block"
        },
        {
          "key": "X-Robots-Tag",
          "value": "none"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache,must-revalidate,max-age=0,no-store,private"
        },
        {
          "key": "Expires",
          "value": "Thu, 01 Jan 1970 00:00:00 GMT"
        },
        {
          "key": "X-ReadOnlyMode",
          "value": "false"
        },
        {
          "key": "Content-Type",
          "value": "application/json;charset=UTF-8"
        },
        {
          "key": "Vary",
          "value": "Accept-Encoding"
        },
        {
          "key": "Content-Encoding",
          "value": "gzip"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"user_code\": \"<user_code>\",\n    \"device_code\": \"<device_code\",\n    \"interval\": integer,\n    \"verification_uri\": \"https://<my_domain>/setup/connect\"\n}"
    }
  ]
}