POSTpartial

Inspect a live token using confidential client authentication

/api/oauth/introspectintrospectAccountOAuthToken

Authentication and authority

No bearer credential is required.

Parameters

This operation has no path, query, or header parameters.

Request body

Required request body.

application/x-www-form-urlencoded

{
  "type": "object",
  "properties": {
    "client_id": {
      "type": "string"
    },
    "client_secret": {
      "type": "string",
      "writeOnly": true
    },
    "token": {
      "type": "string"
    },
    "resource": {
      "type": "string"
    }
  },
  "required": [
    "token",
    "resource"
  ],
  "example": {
    "client_id": "COPY_REGISTERED_CLIENT_ID",
    "resource": "https://peoplescourt.ai/api",
    "client_secret": "COPY_CONFIDENTIAL_CLIENT_SECRET",
    "token": "COPY_TOKEN_TO_INSPECT"
  }
}

Responses

200

Successful operation.

application/json

{
  "type": "object",
  "properties": {
    "active": {
      "type": "boolean"
    },
    "sub": {
      "type": "string"
    },
    "client_id": {
      "type": "string"
    },
    "aud": {
      "type": "string"
    },
    "iss": {
      "type": "string"
    },
    "scope": {
      "type": "string"
    },
    "exp": {
      "type": "integer"
    },
    "iat": {
      "type": "integer"
    },
    "case_id": {
      "type": "string"
    },
    "tenant_id": {
      "type": "string"
    }
  },
  "required": [
    "active"
  ]
}

default

Authorization failure; consent_required requires explicit reacceptance.

application/json

{
  "$ref": "#/components/schemas/AccountOAuthError",
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "error_description": {
      "type": "string"
    }
  },
  "required": [
    "error"
  ]
}

Example response

Successful response

{
  "active": false
}

Errors

Read the response status and stable error code. See errors and rate limits for recovery. Refresh the resource before resolving a state or digest conflict.

Idempotency and retries

For throttling, honor Retry-After when present. Back off on retryable server failures.
The request is accepted only when its credential, authority, case state, and resource preconditions are satisfied.

Use https://peoplescourt.ai with the test credential issued for your integration.

cURL

curl --request POST \
  --url 'https://peoplescourt.ai/api/oauth/introspect' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data "client_id=COPY_REGISTERED_CLIENT_ID&resource=https%3A%2F%2Fpeoplescourt.ai%2Fapi&client_secret=COPY_CONFIDENTIAL_CLIENT_SECRET&token=COPY_TOKEN_TO_INSPECT"

TypeScript / fetch

import type { ApiCanonicalIntrospectAccountOAuthTokenResponse } from "./sdk/typescript/src/index.ts";

const response = await fetch("https://peoplescourt.ai/api/oauth/introspect", {
  method: "POST",
  headers: {
    "Content-Type": "application/x-www-form-urlencoded"
  },
  body: new URLSearchParams({"client_id":"COPY_REGISTERED_CLIENT_ID","resource":"https://peoplescourt.ai/api","client_secret":"COPY_CONFIDENTIAL_CLIENT_SECRET","token":"COPY_TOKEN_TO_INSPECT"}).toString(),
});
if (!response.ok) throw await response.json();
const result: ApiCanonicalIntrospectAccountOAuthTokenResponse = await response.json();

Python

import requests

response = requests.post(
    "https://peoplescourt.ai/api/oauth/introspect",
    headers={
      "Content-Type": "application/x-www-form-urlencoded"
    },
    data={"client_id": "COPY_REGISTERED_CLIENT_ID", "resource": "https://peoplescourt.ai/api", "client_secret": "COPY_CONFIDENTIAL_CLIENT_SECRET", "token": "COPY_TOKEN_TO_INSPECT"},
    timeout=30,
)
response.raise_for_status()
result = response.json()