Chilkat Online Tools

Python / Salesforce Platform APIs / OpenID Connect Token Introspection Endpoint

Back to Collection Items

import sys
import chilkat2

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

http = chilkat2.Http()

req = chilkat2.HttpRequest()

jsonParam1 = chilkat2.JsonObject()
req.AddParam("token",jsonParam1.Emit())
req.AddParam("token_type_hint","access_token")

jsonParam3 = chilkat2.JsonObject()
req.AddParam("client_id",jsonParam3.Emit())

jsonParam4 = chilkat2.JsonObject()
req.AddParam("client_secret",jsonParam4.Emit())

req.AddHeader("Accept","application/json")

# resp is a CkHttpResponse
resp = http.PostUrlEncoded("https://login.salesforce.com{{site}}/services/oauth2/introspect",req)
if (http.LastMethodSuccess == False):
    print(http.LastErrorText)
    sys.exit()

sbResponseBody = chilkat2.StringBuilder()
resp.GetBodySb(sbResponseBody)

jResp = chilkat2.JsonObject()
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

print("Response Body:")
print(jResp.Emit())

respStatusCode = resp.StatusCode
print("Response Status Code = " + str(respStatusCode))
if (respStatusCode >= 400):
    print("Response Header:")
    print(resp.Header)
    print("Failed.")

    sys.exit()

# 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 = jResp.BoolOf("active")
scope = jResp.StringOf("scope")
client_id = jResp.StringOf("client_id")
username = jResp.StringOf("username")
v_sub = jResp.StringOf("sub")
token_type = jResp.StringOf("token_type")
exp = jResp.IntOf("exp")
iat = jResp.IntOf("iat")
nbf = jResp.IntOf("nbf")

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