Skip to main content
ZStack
Identity & Access/ZIAM

ZiamIntrospectToken

Returns whether an access token is active and, when active, its subject, client, scope, expiry, audience, and role summary. The response follows OAuth introspection style and is not wrapped in the normal API response envelope.

POST/api/login/oauth/introspect

Operation ID

ZiamIntrospectToken

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

This API requires no request parameters.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • active
    Boolean

    Whether the token is currently valid and not revoked.

    Example: true

  • sub
    String

    ZIAM user uuid.

    Example: 11111111111111111111111111111111

  • ziam_subject_type
    String

    Signed ZIAM subject type used together with sub to identify the exact token principal.

    Example: User

  • username
    String

    Preferred username.

    Example: alice

  • client_id
    String

    Client id.

    Example: ziam-default-client

  • scope
    String

    Granted scopes.

    Example: openid profile email

  • token_type
    String

    ZIAM token type claim.

    Example: access_token

  • jti
    String

    Access token unique id.

    Example: 11111111111111111111111111111111

  • exp
    Long

    Expiry timestamp in seconds.

    Example: 10

  • iat
    Long

    Issued-at timestamp in seconds.

    Example: 10

  • aud
    List

    Token audiences.

    Example: item1,item2

  • roles
    List

    Small ZIAM role summary carried by the token.

    Example: item1,item2

Change History

View all change history

  • Change Time

    AddedResponse fields ziam_subject_type
    View API