Chilkat Online Tools

Ruby / Salesforce Platform APIs / Username Password Flow

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","password")

jsonParam2 = Chilkat::CkJsonObject.new()
req.AddParam("client_id",jsonParam2.emit())

jsonParam3 = Chilkat::CkJsonObject.new()
req.AddParam("client_secret",jsonParam3.emit())

jsonParam4 = Chilkat::CkJsonObject.new()
req.AddParam("username",jsonParam4.emit())

jsonParam5 = Chilkat::CkJsonObject.new()
req.AddParam("password",jsonParam5.emit())

req.AddHeader("Accept","application/json")

# 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_GOES_HERE",
#   "instance_url": "https://pozil-dev-ed.my.salesforce.com",
#   "id": "https://login.salesforce.com/id/00D58000000arpqEAA/00558000000yFyDAAU",
#   "token_type": "Bearer",
#   "issued_at": "1609942615640",
#   "signature": "SIGNATURE_GOES_HERE"
# }

# 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")
instance_url = jResp.stringOf("instance_url")
id = jResp.stringOf("id")
token_type = jResp.stringOf("token_type")
issued_at = jResp.stringOf("issued_at")
signature = jResp.stringOf("signature")

Curl Command

curl -X POST
	-H "Content-Type: application/x-www-form-urlencoded"
	-H "Accept: application/json"
	--data-urlencode 'grant_type=password'
	--data-urlencode 'client_id={{clientId}}'
	--data-urlencode 'client_secret={{clientSecret}}'
	--data-urlencode 'username={{username}}'
	--data-urlencode 'password={{password}}{{secretToken}}'
https://login.salesforce.com{{site}}/services/oauth2/token

Postman Collection Item JSON

{
  "name": "Username Password Flow",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "const jsonData = pm.response.json();",
          "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"
      }
    }
  ],
  "request": {
    "auth": {
      "type": "noauth"
    },
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/x-www-form-urlencoded"
      },
      {
        "key": "Accept",
        "value": "application/json",
        "type": "text"
      }
    ],
    "body": {
      "mode": "urlencoded",
      "urlencoded": [
        {
          "key": "grant_type",
          "value": "password",
          "type": "text"
        },
        {
          "key": "client_id",
          "value": "{{clientId}}",
          "type": "text"
        },
        {
          "key": "client_secret",
          "value": "{{clientSecret}}",
          "type": "text"
        },
        {
          "key": "username",
          "value": "{{username}}",
          "type": "text"
        },
        {
          "key": "password",
          "value": "{{password}}{{secretToken}}",
          "type": "text"
        }
      ]
    },
    "url": {
      "raw": "{{url}}{{site}}/services/oauth2/token",
      "host": [
        "{{url}}{{site}}"
      ],
      "path": [
        "services",
        "oauth2",
        "token"
      ]
    }
  },
  "response": [
    {
      "name": "Successful OAuth Username Password Login",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/x-www-form-urlencoded"
          },
          {
            "key": "Accept",
            "value": "application/json",
            "type": "text"
          }
        ],
        "body": {
          "mode": "urlencoded",
          "urlencoded": [
            {
              "key": "grant_type",
              "value": "password",
              "type": "text"
            },
            {
              "key": "client_id",
              "value": "CLIENT_ID_GOES_HERE",
              "type": "text"
            },
            {
              "key": "client_secret",
              "value": "CLIENT_SECRET_GOES_HERE",
              "type": "text"
            },
            {
              "key": "username",
              "value": "demo@pozil.org",
              "type": "text"
            },
            {
              "key": "password",
              "value": "PASSWORD_AND_SECURITY_TOKEN_GO_HERE",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "https://login.salesforce.com/services/oauth2/token",
          "protocol": "https",
          "host": [
            "login",
            "salesforce",
            "com"
          ],
          "path": [
            "services",
            "oauth2",
            "token"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Wed, 06 Jan 2021 14:16:55 GMT"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=31536002; includeSubDomains"
        },
        {
          "key": "Public-Key-Pins-Report-Only",
          "value": "pin-sha256=\"9n0izTnSRF+W4W4WhQB8duS2bxVLfzXsY=\"; pin-sha256=\"5kJvNEMw0KjrCAu7eXY5HZdvSP91w=\"; pin-sha256=\"njN4rRG+zPUPHlv4+foULwl1g=\"; max-age=86400; includeSubDomains; report-uri=\"https://a.forcesslreports.com/hpkp-report/00D58000000arpqm\";"
        },
        {
          "key": "Expect-CT",
          "value": "max-age=86400, report-uri=\"https://a.forcesslreports.com/Expect-CT-report/00D58000000arpqm\""
        },
        {
          "key": "X-Robots-Tag",
          "value": "none"
        },
        {
          "key": "X-B3-TraceId",
          "value": "c21e47e40ecc875d"
        },
        {
          "key": "X-B3-SpanId",
          "value": "c21e47e40ecc875d"
        },
        {
          "key": "X-B3-Sampled",
          "value": "0"
        },
        {
          "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    \"access_token\": \"ACCESS_TOKEN_GOES_HERE\",\n    \"instance_url\": \"https://pozil-dev-ed.my.salesforce.com\",\n    \"id\": \"https://login.salesforce.com/id/00D58000000arpqEAA/00558000000yFyDAAU\",\n    \"token_type\": \"Bearer\",\n    \"issued_at\": \"1609942615640\",\n    \"signature\": \"SIGNATURE_GOES_HERE\"\n}"
    }
  ]
}