Check a token with Bage (RFC 7662)

POST

/v1/introspect

curl --request POST \
  --url https://api.trybage.com/v1/introspect \
  --header 'Content-Type: application/json' \
  --data '{ "token": "example" }'

An alternative to checking tokens yourself. Returns active false for a bad, expired or revoked token. It doesn’t check the request signature.

Request Body^required

Media typeapplication/json

object

token

required

The agent token from the agent-token header.

string

Example ^generated

{
  "token": "example"
}

Responses

200

The answer, with the token’s claims when it’s active.

Media typeapplication/json

One of:

object

object

active

required

boolean

object

object

active

required

boolean

iss

required

string

aud

required

The one website this token is for.

string

sub

required

The person. The same for the same person every time.

string

name

The person’s name.

string

email

Only with the email scope.

string format: email

email_verified

Only with the email scope.

boolean

act

required

The agent acting for the person (RFC 8693), and inside it, when the agent runs in a browser platform, the platform.

object

sub

required

string

name

required

string

operator

required

The company that runs the agent.

string

act

The platform whose browser the agent runs in.

object

sub

required

string

name

required

string

operator

required

string

cnf

required

The key requests must be signed with (RFC 7800). The agent’s own, or a session or platform key it bound at sign-in.

object

jkt

required

The key’s JWK thumbprint.

string

jwk

required

object

scope

required

string

test

Only for agents in test mode.

boolean

iat

required

integer

exp

required

integer

jti

required

string

Example

{
  "active": true,
  "iss": "https://api.trybage.com",
  "aud": "https://shop.example",
  "sub": "usr_5b1c9e",
  "name": "Alex Morgan",
  "email_verified": true,
  "act": {
    "sub": "agt_7a3d1f",
    "name": "Scout",
    "operator": "Northwind Labs",
    "act": {
      "sub": "agt_9k2m4p",
      "name": "Kernel"
    }
  },
  "scope": "browse cart",
  "test": true,
  "jti": "tok_8d2e4f"
}