ktor-server-auth-oidc/io.ktor.server.auth.oidc/TokenClaims

TokenClaims

Structured JWT claims access.

Claims are decoded from an already verified token by the OpenID Connect plugin. Accessing these values does not perform verification by itself.

Report a problem

Properties

algorithm

val algorithm: String?

Signing algorithm from the JWT header.

audience

val audience: List<String>

Audience claim values.

expiresAt

val expiresAt: Instant?

Expiration time.

header

val header: JsonObject

Decoded JWT header as JSON.

issuedAt

val issuedAt: Instant?

Issuance time.

issuer

val issuer: String?

Issuer claim.

jwtId

val jwtId: String?

JWT ID claim.

keyId

val keyId: String?

Key identifier from the JWT header.

notBefore

val notBefore: Instant?

Not-before time.

payload

val payload: JsonObject

Decoded JWT payload claims as JSON.

subject

val subject: String?

Subject claim.

type

val type: String?

Type from the JWT header.

Functions

claim

fun claim(name: String): JsonElement?

Returns a decoded JWT payload claim by name.

claimString

fun claimString(name: String): String?

Returns a decoded JWT payload claim as a string.

headerString

fun headerString(name: String): String?

Returns a JWT header value as a string.