Chilkat Online Tools

PureBasic / Salesforce Platform APIs / OpenID Connect Token Introspection Endpoint

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
IncludeFile "CkHttpRequest.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

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

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

    CkHttpRequest::ckAddParam(req,"token",CkJsonObject::ckEmit(jsonParam1))
    CkHttpRequest::ckAddParam(req,"token_type_hint","access_token")

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

    CkHttpRequest::ckAddParam(req,"client_id",CkJsonObject::ckEmit(jsonParam3))

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

    CkHttpRequest::ckAddParam(req,"client_secret",CkJsonObject::ckEmit(jsonParam4))

    CkHttpRequest::ckAddHeader(req,"Accept","application/json")

    resp.i = CkHttp::ckPostUrlEncoded(http,"https://login.salesforce.com{{site}}/services/oauth2/introspect",req)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkHttpRequest::ckDispose(req)
        CkJsonObject::ckDispose(jsonParam1)
        CkJsonObject::ckDispose(jsonParam3)
        CkJsonObject::ckDispose(jsonParam4)
        ProcedureReturn
    EndIf

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

    CkHttpResponse::ckGetBodySb(resp,sbResponseBody)

    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 = CkHttpResponse::ckStatusCode(resp)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttpResponse::ckHeader(resp)
        Debug "Failed."
        CkHttpResponse::ckDispose(resp)

        CkHttp::ckDispose(http)
        CkHttpRequest::ckDispose(req)
        CkJsonObject::ckDispose(jsonParam1)
        CkJsonObject::ckDispose(jsonParam3)
        CkJsonObject::ckDispose(jsonParam4)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

    CkHttpResponse::ckDispose(resp)

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

    ; {
    ;   "active": true,
    ;   "scope": "<scope_list>",
    ;   "client_id": "<client_id>",
    ;   "username": "<username>",
    ;   "sub": "https://login.salesforce.com/id/00D.../005...",
    ;   "token_type": "access_token",
    ;   "exp": <timestamp>,
    ;   "iat": <timestamp>,
    ;   "nbf": <timestamp>
    ; }

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

    active.i = CkJsonObject::ckBoolOf(jResp,"active")
    scope.s = CkJsonObject::ckStringOf(jResp,"scope")
    client_id.s = CkJsonObject::ckStringOf(jResp,"client_id")
    username.s = CkJsonObject::ckStringOf(jResp,"username")
    v_sub.s = CkJsonObject::ckStringOf(jResp,"sub")
    token_type.s = CkJsonObject::ckStringOf(jResp,"token_type")
    exp.i = CkJsonObject::ckIntOf(jResp,"exp")
    iat.i = CkJsonObject::ckIntOf(jResp,"iat")
    nbf.i = CkJsonObject::ckIntOf(jResp,"nbf")


    CkHttp::ckDispose(http)
    CkHttpRequest::ckDispose(req)
    CkJsonObject::ckDispose(jsonParam1)
    CkJsonObject::ckDispose(jsonParam3)
    CkJsonObject::ckDispose(jsonParam4)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure

Curl Command

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

Postman Collection Item JSON

{
  "name": "OpenID Connect Token Introspection Endpoint",
  "request": {
    "auth": {
      "type": "noauth"
    },
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "value": "application/x-www-form-urlencoded",
        "type": "text"
      },
      {
        "key": "Accept",
        "value": "application/json",
        "type": "text"
      }
    ],
    "body": {
      "mode": "urlencoded",
      "urlencoded": [
        {
          "key": "token",
          "value": "{{_accessToken}}",
          "type": "text"
        },
        {
          "key": "token_type_hint",
          "value": "access_token",
          "type": "text"
        },
        {
          "key": "client_id",
          "value": "{{clientId}}",
          "type": "text"
        },
        {
          "key": "client_secret",
          "value": "{{clientSecret}}",
          "type": "text"
        }
      ]
    },
    "url": {
      "raw": "{{url}}{{site}}/services/oauth2/introspect",
      "host": [
        "{{url}}{{site}}"
      ],
      "path": [
        "services",
        "oauth2",
        "introspect"
      ]
    }
  },
  "response": [
    {
      "name": "Successful OpenID Connect Token Introspection Endpoint",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/x-www-form-urlencoded"
          },
          {
            "key": "Accept",
            "value": "application/json"
          }
        ],
        "body": {
          "mode": "urlencoded",
          "urlencoded": [
            {
              "key": "token",
              "value": "{{_accessToken}}",
              "type": "text"
            },
            {
              "key": "token_type_hint",
              "value": "access_token",
              "type": "text"
            },
            {
              "key": "client_id",
              "value": "{{clientId}}",
              "type": "text"
            },
            {
              "key": "client_secret",
              "value": "{{clientSecret}}",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{url}}{{site}}/services/oauth2/introspect",
          "host": [
            "{{url}}{{site}}"
          ],
          "path": [
            "services",
            "oauth2",
            "introspect"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Thu, 16 Nov 2023 15:54:42 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    \"active\": true,\n    \"scope\": \"<scope_list>\",\n    \"client_id\": \"<client_id>\",\n    \"username\": \"<username>\",\n    \"sub\": \"https://login.salesforce.com/id/00D.../005...\",\n    \"token_type\": \"access_token\",\n    \"exp\": <timestamp>,\n    \"iat\": <timestamp>,\n    \"nbf\": <timestamp>\n}"
    }
  ]
}