Chilkat Online Tools

PureBasic / Salesforce Platform APIs / User Info

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckQuickGetSb(http,"https://login.salesforce.com{{site}}/services/oauth2/userinfo",sbResponseBody)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    jResp.i = CkJsonObject::ckCreate()
    If jResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jResp,sbResponseBody)
    CkJsonObject::setCkEmitCompact(jResp, 0)

    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

    respStatusCode.i = CkHttp::ckLastStatus(http)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttp::ckLastHeader(http)
        Debug "Failed."
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    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

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


    CkHttp::ckDispose(http)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure

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