TrieOH
IdentityXAPIAuthn

Introspect the current identity

Returns the identity resolved from the current credential — the actor (subject) plus the credential type used (JWT token or API key). API keys authenticate with their full raw key; the subject carries the key's capability grants.

GET/auth/introspect

Returns the identity resolved from the current credential — the actor (subject) plus the credential type used (JWT token or API key). API keys authenticate with their full raw key; the subject carries the key's capability grants.

Authorization

AuthorizationBearer <token>

JWT issued by IdentityX, signed with Ed25519

In: header

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/auth/introspect"
{
  "subject": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
    "email": "user@example.com",
    "type": "human",
    "verified_at": "2019-08-24T14:15:22Z",
    "capabilities": {},
    "metadata": {}
  },
  "cred": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "type": "token"
  }
}
{
  "detail": "string",
  "instance": "../dictionary",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "type": "http://example.com",
  "status": 401,
  "title": "Unauthenticated"
}
{
  "detail": "string",
  "instance": "../dictionary",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "type": "http://example.com",
  "status": 500,
  "title": "Internal Server Error"
}
{
  "detail": "string",
  "instance": "../dictionary",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "type": "http://example.com",
  "status": 503,
  "title": "Identity Unavailable"
}