API Reference

Krystal Identity API

Resources & Endpoints

Introspect token

Returns details about a given access or refresh token.

GET
https://identity.krystal.io/api/v1/tokens/introspect

If successful, this endpoint will return a 200 OK status.

Arguments

The following arguments are supported for this endpoint.

Name Type Default Value

token Required

String None

Potential Errors

The following errors may occur during this request.

Details HTTP status

token_owner_suspended

The owner of this token has been suspended

 403 Forbidden

Returned Object

When the request is successful, you can expect an object matching the specification below to be returned.

{
    active: Boolean
    client_id: String?
    expiry: Unix Timestamp?
    scopes: [ String ]
    session_id: String?
    subject_type: OAuth token subject type
    subject: String
    type: String
    use: OAuth token uses
}