Skip to main content

Overview

Allows a service to authenticate a JWT token issued by the broker. This resource does not require authenticated access. Any service that receives a JWT token issued by the broker can request the broker to validate the token, and to return parsed information available in the token.

HTTP request

POST /Agent/Account/AuthenticateJwt

Authentication

Requires a valid JWT bearer token.

Request (JSON)

{
	"token":Optional(Str(PToken))
}

Input parameters

ParameterDescription
PTokenJWT token to validate.

Response (JSON)

{
	"header":Required(Str(PHeader)),
	"payload":Required(Str(PPayload)),
	"signature":Required(Str(PSignature)),
	"algorithm":Required(Str(PAlgorithm)),
	"claims":Required(PClaims),
	"type":Optional(Str(PType)),
	"issuer":Optional(Str(PIssuer)),
	"subject":Optional(Str(PSubject)),
	"id":Optional(Str(PId)),
	"audience":Optional(Str(PAudience[])),
	"expiration":Optional(DateTime(PExpiration)),
	"notBefore":Optional(DateTime(PNotBefore)),
	"issuedAt":Optional(DateTime(PIssuedAt))
}

Response parameters

ParameterDescription
PJwtA token representing the login to the account. This token is seant as a Bearer token in requests requiring authentication.
PPayloadPayload portion of the token.
PSignatureSignature portion of the token
PAlgorithmAlgorithm used to sign token.
PTypeType of token.
PIssuerIssuer of token.
PSubjectSubject of the token.
PIdIdentifier of token.
PAudienceAudience for token.
PExpirationWhen token expires.
PNotBeforeIf token has a not-before timestamp.
PIssuedAtWhen token was created.

Notes

This endpoint uses the request schema notation described in Pattern matching.