Chilkat Online Tools

lianja / Salesforce Platform APIs / User Info

Back to Collection Items

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

loHttp = createobject("CkHttp")

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

loSbResponseBody = createobject("CkStringBuilder")
llSuccess = loHttp.QuickGetSb("https://login.salesforce.com{{site}}/services/oauth2/userinfo",loSbResponseBody)
if (llSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loSbResponseBody
    return
endif

loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
    ? "Response Header:"
    ? loHttp.LastHeader
    ? "Failed."
    release loHttp
    release loSbResponseBody
    release loJResp
    return
endif

// 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

lcV_sub = loJResp.StringOf("sub")
lcUser_id = loJResp.StringOf("user_id")
lcOrganization_id = loJResp.StringOf("organization_id")
lcPreferred_username = loJResp.StringOf("preferred_username")
lcNickname = loJResp.StringOf("nickname")
lcName = loJResp.StringOf("name")
lcEmail = loJResp.StringOf("email")
llEmail_verified = loJResp.BoolOf("email_verified")
lcGiven_name = loJResp.StringOf("given_name")
lcFamily_name = loJResp.StringOf("family_name")
lcZoneinfo = loJResp.StringOf("zoneinfo")
lcPicture = loJResp.StringOf("photos.picture")
lcThumbnail = loJResp.StringOf("photos.thumbnail")
lcProfile = loJResp.StringOf("profile")
lcPicture = loJResp.StringOf("picture")
lcCountry = loJResp.StringOf("address.country")
llIs_salesforce_integration_user = loJResp.BoolOf("is_salesforce_integration_user")
lcEnterprise = loJResp.StringOf("urls.enterprise")
lcMetadata = loJResp.StringOf("urls.metadata")
lcPartner = loJResp.StringOf("urls.partner")
lcV_Rest = loJResp.StringOf("urls.rest")
lcSobjects = loJResp.StringOf("urls.sobjects")
lcSearch = loJResp.StringOf("urls.search")
lcQuery = loJResp.StringOf("urls.query")
lcRecent = loJResp.StringOf("urls.recent")
lcTooling_soap = loJResp.StringOf("urls.tooling_soap")
lcTooling_rest = loJResp.StringOf("urls.tooling_rest")
lcProfile = loJResp.StringOf("urls.profile")
lcFeeds = loJResp.StringOf("urls.feeds")
lcGroups = loJResp.StringOf("urls.groups")
lcUsers = loJResp.StringOf("urls.users")
lcFeed_items = loJResp.StringOf("urls.feed_items")
lcFeed_elements = loJResp.StringOf("urls.feed_elements")
lcCustom_domain = loJResp.StringOf("urls.custom_domain")
llActive = loJResp.BoolOf("active")
lcUser_type = loJResp.StringOf("user_type")
lcLanguage = loJResp.StringOf("language")
lcLocale = loJResp.StringOf("locale")
lnUtcOffset = loJResp.IntOf("utcOffset")
lcUpdated_at = loJResp.StringOf("updated_at")
llIs_app_installed = loJResp.BoolOf("is_app_installed")


release loHttp
release loSbResponseBody
release loJResp

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