kjwt-core/co.touchlab.kjwt.model/JwtPayload

JwtPayload

@Serializable(with = JwtPayloadSerializer::class)

class JwtPayload(source)

Immutable representation of a JWT payload (claims set) as defined in RFC 7519.

The payload is backed by a JsonObject and also stored in its base64url-encoded form so that the compact serialization can be reproduced exactly. Registered claim names (e.g. iss, sub, aud, exp) are accessible through named properties on Builder; arbitrary custom claims can be read with getClaim and getClaimOrNull.

See also

JwtPayload.Builder

Types

Builder for constructing a JwtPayload with standard and custom claims.

object Companion

Properties

val JwtPayload.audience: Set<String>

Returns the aud (audience) claim value as a set of strings.

val JwtPayload.audienceOrNull: Set<String>?

Returns the aud (audience) claim value as a set of strings, or null if the claim is absent.

val JwtPayload.expiration: Instant

Returns the exp (expiration time) claim value as an Instant.

expirationOrNull

val JwtPayload.expirationOrNull: Instant?

Returns the exp (expiration time) claim value as an Instant, or null if the claim is absent.

val JwtPayload.issuedAt: Instant

Returns the iat (issued at) claim value as an Instant.

val JwtPayload.issuedAtOrNull: Instant?

Returns the iat (issued at) claim value as an Instant, or null if the claim is absent.

val JwtPayload.issuer: String

Returns the iss (issuer) claim value.

val JwtPayload.issuerOrNull: String?

Returns the iss (issuer) claim value, or null if the claim is absent.

val JwtPayload.jwtId: String

Returns the jti (JWT ID) claim value.

val JwtPayload.jwtIdOrNull: String?

Returns the jti (JWT ID) claim value, or null if the claim is absent.

val JwtPayload.notBefore: Instant

Returns the nbf (not before) claim value as an Instant.

notBeforeOrNull

val JwtPayload.notBeforeOrNull: Instant?

Returns the nbf (not before) claim value as an Instant, or null if the claim is absent.

val JwtPayload.subject: String

Returns the sub (subject) claim value.

val JwtPayload.subjectOrNull: String?

Returns the sub (subject) claim value, or null if the claim is absent.

Functions

open operator override fun equals(other: Any?): Boolean

fun <T> getClaim(serializer: DeserializationStrategy<T>, name: String, jsonInstance: Json = Jwt.defaultJsonParser): T

Returns the value of the named claim, deserialized using the given serializer.

inline fun <T> JwtPayload.getClaim(name: String, jsonInstance: Json = Jwt.defaultJsonParser): T

Returns the value of the named claim, deserializing it to type T using a reified serializer.

fun <T> getClaimOrNull(serializer: DeserializationStrategy<T>, name: String, jsonInstance: Json = Jwt.defaultJsonParser): T?

Returns the value of the named claim deserialized using the given serializer, or null if absent.

inline fun <T> JwtPayload.getClaimOrNull(name: String, jsonInstance: Json = Jwt.defaultJsonParser): T?

Returns the value of the named claim deserialized to type T, or null if the claim is absent.

fun hasClaim(name: String): Boolean

Returns true if a claim with the given name exists in the payload.

open override fun hashCode(): Int

open override fun toString(): String