Sign in
latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-216381,9552.9 MB

f2cf3228f366

Auth

Introspect

Introspect returns the current user's principle_id, user_id and a list of roles, permissions, and enabled features.

get/api/v1/auth/introspect

Response

IntrospectResponse contains information about the current user who is authenticated.

deviceClientIdstring

The OAuth client_id of the device client registered for this token. Present only on tokens issued by the device registration grant; the client reads it once and presents it on the subsequent token exchange. Empty for all other tokens.

disabledModulesstring[] nullable

The modules turned off for the tenant the logged in user belongs to. Absent from this list means enabled: every module is on by default. Clients MUST treat an unrecognized value as "a module this client does not know about is disabled".

featuresstring[] nullable

The list of feature flags enabled for the tenant the logged in user belongs to.

permissionsstring[] nullable

The list of permissions that the current logged in user has.

principleIdstring

The principleID of the current logged in user.

rolesstring[] nullable

The list of roles that the current logged in user has.

tenantIdstring

The tenantID from the authenticated caller's passport.

userIdstring

The userID of the current logged in user.