Auth.ValidateToken

Try it in Swagger

Endpoint

Request Schema

Headers

Header Required Notes
X-Api-Key Required when tenant is not resolved by subdomain The long hex API key. Resolves the tenant. Do not put this value in the body.

JSON Body

Body type: JwtTokenRequest

Field Type Required Max Length Notes
token string Yes

Request Sample

{
  "token": "string"
}

Expected Response Schema

Status Codes

Status Notes
200 OK Returned by the controller for this operation.

Success Body

Response type: JwtTokenResponse

Field Type Max Length Notes
valid bool
message string
user JwtUserInfo?
claims List<JwtClaim>?

Response Sample

{
  "valid": 123,
  "message": "Token is valid.",
  "user": "api.user@example.com",
  "claims": [
    "CustomerCode:ABC001"
  ]
}