Chilkat Online Tools

TCL / Salesforce Platform APIs / User Info

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

CkHttp_SetRequestHeader $http "Content-Type" "application/json"

set sbResponseBody [new_CkStringBuilder]

set success [CkHttp_QuickGetSb $http "https://login.salesforce.com{{site}}/services/oauth2/userinfo" $sbResponseBody]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    exit
}

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttp_lastHeader $http]
    puts "Failed."
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

# 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

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

delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp

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}"
    }
  ]
}