Chilkat Online Tools

Ruby / Salesforce Platform APIs / Client Credentials Flow - basic authorization header

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.AddParam("grant_type","client_credentials")

req.AddHeader("Authorization","Basic {{clientCredential_basicAuthEncoded}}")

# resp is a CkHttpResponse
resp = http.PostUrlEncoded("https://login.salesforce.com{{site}}/services/oauth2/token",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)

# {
#   "access_token": "<access_token>",
#   "signature": "<signature>",
#   "scope": "<scope list>",
#   "instance_url": "https://<my_domain>",
#   "id": "https://login.salesforce.com/id/00D.../005...",
#   "token_type": "Bearer",
#   "issued_at": "<timestamp>",
#   "api_instance_url": "https://api.salesforce.com"
# }

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

access_token = jResp.stringOf("access_token")
signature = jResp.stringOf("signature")
scope = jResp.stringOf("scope")
instance_url = jResp.stringOf("instance_url")
id = jResp.stringOf("id")
token_type = jResp.stringOf("token_type")
issued_at = jResp.stringOf("issued_at")
api_instance_url = jResp.stringOf("api_instance_url")

Curl Command

curl -X POST
	-H "Content-Type: application/x-www-form-urlencoded"
	-H "Authorization: Basic {{clientCredential_basicAuthEncoded}}"
	--data-urlencode 'grant_type=client_credentials'
https://login.salesforce.com{{site}}/services/oauth2/token

Postman Collection Item JSON

{
  "name": "Client Credentials Flow - basic authorization header",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "const jsonData = pm.response.json();",
          "",
          "if(!jsonData.error){",
          "    const id = jsonData.id.split('/');",
          "    const context = pm.environment.name ? pm.environment : pm.collectionVariables;",
          "    context.set(\"_accessToken\", jsonData.access_token);",
          "    context.set(\"_endpoint\", jsonData.instance_url);",
          "    context.set(\"_userId\", id.pop());",
          "    context.set(\"_orgId\", id.pop());",
          "}"
        ],
        "type": "text/javascript"
      }
    },
    {
      "listen": "prerequest",
      "script": {
        "exec": [
          "const context = pm.environment.name ? pm.environment : pm.collectionVariables;",
          "",
          "const basicAuth = context.get(\"clientId\") + \":\" + context.get(\"clientSecret\");",
          "const basicAuthEncoded = CryptoJS.enc.Base64.stringify(CryptoJS.enc.Utf8.parse(basicAuth));",
          "",
          "pm.environment.set(\"clientCredential_basicAuthEncoded\", basicAuthEncoded);"
        ],
        "type": "text/javascript"
      }
    }
  ],
  "protocolProfileBehavior": {
    "disableCookies": true
  },
  "request": {
    "auth": {
      "type": "noauth"
    },
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/x-www-form-urlencoded"
      },
      {
        "key": "Authorization",
        "value": "Basic {{clientCredential_basicAuthEncoded}}",
        "description": "Base64 encoded basic credentials (see pre-request script)"
      }
    ],
    "body": {
      "mode": "urlencoded",
      "urlencoded": [
        {
          "key": "grant_type",
          "value": "client_credentials",
          "type": "text"
        },
        {
          "key": "client_id",
          "value": "{{clientId}}",
          "type": "text",
          "disabled": true
        },
        {
          "key": "client_secret",
          "value": "{{clientSecret}}",
          "type": "text",
          "disabled": true
        }
      ]
    },
    "url": {
      "raw": "{{url}}{{site}}/services/oauth2/token",
      "host": [
        "{{url}}{{site}}"
      ],
      "path": [
        "services",
        "oauth2",
        "token"
      ]
    }
  },
  "response": [
    {
      "name": "Successful Client Credentials Flow - basic authorization header",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/x-www-form-urlencoded"
          },
          {
            "key": "Authorization",
            "value": "Basic {{clientCredential_basicAuthEncoded}}",
            "description": "Base64 encoded basic credentials (see pre-request script)"
          }
        ],
        "body": {
          "mode": "urlencoded",
          "urlencoded": [
            {
              "key": "grant_type",
              "value": "client_credentials",
              "type": "text"
            },
            {
              "key": "client_id",
              "value": "{{clientId}}",
              "type": "text",
              "disabled": true
            },
            {
              "key": "client_secret",
              "value": "{{clientSecret}}",
              "type": "text",
              "disabled": true
            }
          ]
        },
        "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:08 GMT"
        },
        {
          "key": "Set-Cookie",
          "value": "CookieConsentPolicy=0:1; path=/; expires=Fri, 15-Nov-2024 15:29:08 GMT; Max-Age=31536000"
        },
        {
          "key": "Set-Cookie",
          "value": "LSKey-c$CookieConsentPolicy=0:1; path=/; expires=Fri, 15-Nov-2024 15:29:08 GMT; Max-Age=31536000"
        },
        {
          "key": "Set-Cookie",
          "value": "BrowserId=4pAG8YSUEe6FQrcdNvkArw; domain=.salesforce.com; path=/; expires=Fri, 15-Nov-2024 15:29:08 GMT; Max-Age=31536000"
        },
        {
          "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": "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    \"access_token\": \"<access_token>\",\n    \"signature\": \"<signature>\",\n    \"scope\": \"<scope list>\",\n    \"instance_url\": \"https://<my_domain>\",\n    \"id\": \"https://login.salesforce.com/id/00D.../005...\",\n    \"token_type\": \"Bearer\",\n    \"issued_at\": \"<timestamp>\",\n    \"api_instance_url\": \"https://api.salesforce.com\"\n}"
    }
  ]
}