OAuth 2.0 Tokens

Introspect Access Token

post/v1/oauth2/token/introspect

Request

  • Base URL: https://api.lucid.co
  • URL: https://api.lucid.co/v1/oauth2/token/introspect
  • Auth: OAuth 2 (authorization code, authorization URL https://lucid.app/oauth2/authorize, token URL https://api.lucid.co/oauth2/token)

Response

OK with information about the token, as specified in OAuth2 Introspect Token

activeboolean required

A boolean value indicating whether or not the token is active.

client_idstring required

The client ID.

expires_innumber required

The remaining lifetime in seconds of the access token.

expiresnumber required

Timestamp for when this token expires (expressed in milliseconds since Unix epoch).

scopestring required

Space-separated list of scopes allowed on this token.

token_typestring required

The type of token returned (currently, always "bearer").

user_idnumber required

ID of the user this token is on behalf of. Only returned when the token was granted on behalf of a user. Mutually exclusive with account_id.

account_idnumber required

ID of the account this token is on behalf of. Only returned when the token was granted on behalf of an account. Mutually exclusive with user_id.

Example response

{
  "active": true,
  "client_id": "30VYbvlkqZv-SmJd7fTdpH9B9et2yqZA6Wvi5NY_",
  "expires_in": 3500,
  "expires": 1605732868411,
  "scope": "document.app offline_access",
  "token_type": "bearer",
  "user_id": 1001,
  "account_id": 52
}

Changes

No recorded changes to this operation across all 1 revision of this API.