Chilkat Online Tools

Ruby / Salesforce Platform APIs / User Info

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()

http.SetRequestHeader("Content-Type","application/json")

sbResponseBody = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://login.salesforce.com{{site}}/services/oauth2/userinfo",sbResponseBody)
if (success == false)
    print http.lastErrorText() + "\n";
    exit
end

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

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

respStatusCode = http.get_LastStatus()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print http.lastHeader() + "\n";
    print "Failed." + "\n";
    exit
end

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

# {
#   "sub": "https://login.salesforce.com/id/00D.../005...",
#   "user_id": "005...",
#   "organization_id": "00D...",
#   "preferred_username": "<username>",
#   "nickname": "<nickname>",
#   "name": "<name>",
#   "email": "<email>",
#   "email_verified": true,
#   "given_name": "<name>",
#   "family_name": "<name>",
#   "zoneinfo": "Europe/Paris",
#   "photos": {
#     "picture": "https://<file_domain>/profilephoto/005/F",
#     "thumbnail": "https://<file_domain>/profilephoto/005/T"
#   },
#   "profile": "https://<my_domain>/005",
#   "picture": "https://<file_domain>/profilephoto/005/F",
#   "address": {
#     "country": "FR"
#   },
#   "is_salesforce_integration_user": false,
#   "urls": {
#     "enterprise": "https://<my_domain>/services/Soap/c/{version}/00D...",
#     "metadata": "https://<my_domain>/services/Soap/m/{version}/00D...",
#     "partner": "https://<my_domain>/services/Soap/u/{version}/00D...",
#     "rest": "https://<my_domain>/services/data/v{version}/",
#     "sobjects": "https://<my_domain>/services/data/v{version}/sobjects/",
#     "search": "https://<my_domain>/services/data/v{version}/search/",
#     "query": "https://<my_domain>/services/data/v{version}/query/",
#     "recent": "https://<my_domain>/services/data/v{version}/recent/",
#     "tooling_soap": "https://<my_domain>/services/Soap/T/{version}/00D...",
#     "tooling_rest": "https://<my_domain>/services/data/v{version}/tooling/",
#     "profile": "https://<my_domain>/0052o00000DOJ1PAAX",
#     "feeds": "https://<my_domain>/services/data/v{version}/chatter/feeds",
#     "groups": "https://<my_domain>/services/data/v{version}/chatter/groups",
#     "users": "https://<my_domain>/services/data/v{version}/chatter/users",
#     "feed_items": "https://<my_domain>/services/data/v{version}/chatter/feed-items",
#     "feed_elements": "https://<my_domain>/services/data/v{version}/chatter/feed-elements",
#     "custom_domain": "https://<my_domain>"
#   },
#   "active": true,
#   "user_type": "STANDARD",
#   "language": "en_US",
#   "locale": "fr_FR_EURO",
#   "utcOffset": 3600000,
#   "updated_at": "<datetime>",
#   "is_app_installed": true
# }

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

v_sub = jResp.stringOf("sub")
user_id = jResp.stringOf("user_id")
organization_id = jResp.stringOf("organization_id")
preferred_username = jResp.stringOf("preferred_username")
nickname = jResp.stringOf("nickname")
name = jResp.stringOf("name")
email = jResp.stringOf("email")
email_verified = jResp.BoolOf("email_verified")
given_name = jResp.stringOf("given_name")
family_name = jResp.stringOf("family_name")
zoneinfo = jResp.stringOf("zoneinfo")
Picture = jResp.stringOf("photos.picture")
Thumbnail = jResp.stringOf("photos.thumbnail")
profile = jResp.stringOf("profile")
picture = jResp.stringOf("picture")
Country = jResp.stringOf("address.country")
is_salesforce_integration_user = jResp.BoolOf("is_salesforce_integration_user")
Enterprise = jResp.stringOf("urls.enterprise")
Metadata = jResp.stringOf("urls.metadata")
Partner = jResp.stringOf("urls.partner")
v_Rest = jResp.stringOf("urls.rest")
Sobjects = jResp.stringOf("urls.sobjects")
Search = jResp.stringOf("urls.search")
Query = jResp.stringOf("urls.query")
Recent = jResp.stringOf("urls.recent")
Tooling_soap = jResp.stringOf("urls.tooling_soap")
Tooling_rest = jResp.stringOf("urls.tooling_rest")
Profile = jResp.stringOf("urls.profile")
Feeds = jResp.stringOf("urls.feeds")
Groups = jResp.stringOf("urls.groups")
Users = jResp.stringOf("urls.users")
Feed_items = jResp.stringOf("urls.feed_items")
Feed_elements = jResp.stringOf("urls.feed_elements")
Custom_domain = jResp.stringOf("urls.custom_domain")
active = jResp.BoolOf("active")
user_type = jResp.stringOf("user_type")
language = jResp.stringOf("language")
locale = jResp.stringOf("locale")
utcOffset = jResp.IntOf("utcOffset")
updated_at = jResp.stringOf("updated_at")
is_app_installed = jResp.BoolOf("is_app_installed")

Curl Command

curl -X GET
	-H "Content-Type: application/json"
https://login.salesforce.com{{site}}/services/oauth2/userinfo

Postman Collection Item JSON

{
  "name": "User Info",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{url}}{{site}}/services/oauth2/userinfo",
      "host": [
        "{{url}}{{site}}"
      ],
      "path": [
        "services",
        "oauth2",
        "userinfo"
      ]
    }
  },
  "response": [
    {
      "name": "Successful User Info",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{url}}{{site}}/services/oauth2/userinfo",
          "host": [
            "{{url}}{{site}}"
          ],
          "path": [
            "services",
            "oauth2",
            "userinfo"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Thu, 16 Nov 2023 15:35:50 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": "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    \"sub\": \"https://login.salesforce.com/id/00D.../005...\",\n    \"user_id\": \"005...\",\n    \"organization_id\": \"00D...\",\n    \"preferred_username\": \"<username>\",\n    \"nickname\": \"<nickname>\",\n    \"name\": \"<name>\",\n    \"email\": \"<email>\",\n    \"email_verified\": true,\n    \"given_name\": \"<name>\",\n    \"family_name\": \"<name>\",\n    \"zoneinfo\": \"Europe/Paris\",\n    \"photos\": {\n        \"picture\": \"https://<file_domain>/profilephoto/005/F\",\n        \"thumbnail\": \"https://<file_domain>/profilephoto/005/T\"\n    },\n    \"profile\": \"https://<my_domain>/005\",\n    \"picture\": \"https://<file_domain>/profilephoto/005/F\",\n    \"address\": {\n        \"country\": \"FR\"\n    },\n    \"is_salesforce_integration_user\": false,\n    \"urls\": {\n        \"enterprise\": \"https://<my_domain>/services/Soap/c/{version}/00D...\",\n        \"metadata\": \"https://<my_domain>/services/Soap/m/{version}/00D...\",\n        \"partner\": \"https://<my_domain>/services/Soap/u/{version}/00D...\",\n        \"rest\": \"https://<my_domain>/services/data/v{version}/\",\n        \"sobjects\": \"https://<my_domain>/services/data/v{version}/sobjects/\",\n        \"search\": \"https://<my_domain>/services/data/v{version}/search/\",\n        \"query\": \"https://<my_domain>/services/data/v{version}/query/\",\n        \"recent\": \"https://<my_domain>/services/data/v{version}/recent/\",\n        \"tooling_soap\": \"https://<my_domain>/services/Soap/T/{version}/00D...\",\n        \"tooling_rest\": \"https://<my_domain>/services/data/v{version}/tooling/\",\n        \"profile\": \"https://<my_domain>/0052o00000DOJ1PAAX\",\n        \"feeds\": \"https://<my_domain>/services/data/v{version}/chatter/feeds\",\n        \"groups\": \"https://<my_domain>/services/data/v{version}/chatter/groups\",\n        \"users\": \"https://<my_domain>/services/data/v{version}/chatter/users\",\n        \"feed_items\": \"https://<my_domain>/services/data/v{version}/chatter/feed-items\",\n        \"feed_elements\": \"https://<my_domain>/services/data/v{version}/chatter/feed-elements\",\n        \"custom_domain\": \"https://<my_domain>\"\n    },\n    \"active\": true,\n    \"user_type\": \"STANDARD\",\n    \"language\": \"en_US\",\n    \"locale\": \"fr_FR_EURO\",\n    \"utcOffset\": 3600000,\n    \"updated_at\": \"<datetime>\",\n    \"is_app_installed\": true\n}"
    }
  ]
}