Sign in

v1

latestOpenAPI 3.0.12026-07-244011,5573.5 MB
Authentication

Get access token by value

Returns the metadata for the supplied token value (type, client_id, identity_id, expires_in, scopes). Use this when the caller has the token string and needs to introspect it; for the calling identity's own active token use GET /v4/tokens instead.

get/v4/tokens/{token}

Path parameters

tokenstring required

Response

Successful response

access_tokenstring

Token string. Send as Authorization: Bearer <access_token> on subsequent requests, or as the access_token query parameter / extole_token cookie.

client_idstring

Stable Extole identifier for the client (tenant) this token authenticates against.

expires_ininteger

Seconds until this token expires. Once expired, requests using it return 401 invalid_access_token; rotate via PUT /v4/tokens/exchange/{token} before expiry to keep long-lived integrations alive.

identity_idstring

Stable Extole identifier for the identity (user, managed identity, or resource) that this token represents.

person_idstring

Deprecated alias for identity_id. New integrations should use identity_id.

scopesstring[]

Authorization scopes granted to this token. Determines which API operations the token may invoke.

type'MANAGED' | 'RESOURCE' | 'USER'

Authentication shape backing the token. USER represents a human dashboard user, MANAGED an OAuth-style managed identity, and RESOURCE a scoped per-resource token.