Introspect Token

Get information about an access token.

POST /v1/oauth2/introspect

PHP (SDK)

PHP

declare(strict_types=1);

require 'vendor/autoload.php';

use Spaire;
use Spaire\Models\Components;

$sdk = Spaire\Spaire::builder()->build();

$request = new Components\IntrospectTokenRequest(
    token: '<value>',
    clientId: '<id>',
    clientSecret: '<value>',
);

$response = $sdk->oauth2->introspect(
    request: $request
);

if ($response->introspectTokenResponse !== null) {
    // handle response
}

200

{
  "active": true,
  "client_id": "<string>",
  "scope": "<string>",
  "sub": "<string>",
  "aud": "<string>",
  "iss": "<string>",
  "exp": 123,
  "iat": 123
}

Body

application/x-www-form-urlencoded

token · string · required

client_id · string · required

client_secret · string · required

token_type_hint · enum<string> | null

Available options: access_token, refresh_token

Response

200 - application/json

Successful Response

active · boolean · required

client_id · string · required

token_type · enum<string> · required

Available options: access_token, refresh_token

scope · string · required

sub_type · enum<string> · required

Available options: user, organization

sub · string · required

aud · string · required

iss · string · required

exp · integer · required

iat · integer · required