ktor-server-auth-jwt/io.ktor.server.auth.jwt/JWTCredential

JWTCredential

class JWTCredential(val payload: Payload) : JWTPayloadHolder, Credential

A JWT credential that consists of the specified payload.

Parameters

payload

JWT

Constructors

JWTCredential

constructor(payload: Payload)

Properties

audience

val audience: List<String>

Gets the value of the aud (audience) claim, or an empty list if it's not available. The aud claim specifies a recipient for which the JWT is intended.

expiresAt

val expiresAt: Date?

Gets the value of the exp (expiration time) claim, or null if it's not available. This claim specifies a time after which the JWT expires.

issuedAt

val issuedAt: Date?

Gets the value of the iat (issued at) claim, or null if it's not available. The iat claim specifies a time at which the JWT was issued. This claim can be used to determine the age of the JWT.

issuer

val issuer: String?

Gets a value of the iss (issuer) claim, which specifies the issuer of the JWT.

jwtId

val jwtId: String?

Gets the value of the jti (JWT ID) claim, or null if it's not available. The jti claim specifies provides a unique identifier for the JWT. This claim can be used to prevent the JWT from being replayed (allows a token to be used only once).

notBefore

val notBefore: Date?

Gets the value of the nbf (not before time) claim, or null if it's not available. The nbf specifies a time before which the JWT must not be accepted for processing.

payload

val payload: Payload

A JWT payload.

subject

val subject: String?

Gets a value of the sub (subject) claim, or null if it's not available. The sub claim specifies a subject of the JWT (the user).