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

Builder

class Builder(source)

Builder for constructing a JwtPayload with standard and custom claims.

Constructors

Builder

constructor()

Properties

audience

var audience: Set<String>?

The audience (aud) claim identifying the recipients that the token is intended for.

expiration

var expiration: Instant?

The expiration time (exp) claim, expressed as an epoch-seconds timestamp.

var id: String?

The JWT ID (jti) claim providing a unique identifier for this token.

issuedAt

var issuedAt: Instant?

The issued-at (iat) claim identifying the time at which the token was issued.

issuer

var issuer: String?

The issuer (iss) claim identifying the principal that issued the token.

notBefore

var notBefore: Instant?

The not-before (nbf) claim; the token must not be accepted before this time.

subject

var subject: String?

The subject (sub) claim identifying the principal that is the subject of the token.

Functions

claim

inline fun <T> claim(name: String, value: T)

Sets a typed claim, inferring the serializer from the reified type T.

fun claim(name: String, value: JsonElement?)

Sets a raw claim using a pre-built JsonElement, or removes it if value is null.

fun <T> claim(name: String, serializer: SerializationStrategy<T>, value: T?, jsonInstance: Json = Jwt.defaultJsonParser)

Sets a typed claim using an explicit SerializationStrategy.

expiresIn

fun expiresIn(duration: Duration)

Sets the expiration time (exp) claim relative to the current time.

issuedNow

fun issuedNow()

Sets the issued-at (iat) claim to the current time.

notBeforeNow

fun notBeforeNow()

Sets the not-before (nbf) claim to the current time.

randomId

@ExperimentalUuidApi

fun randomId()

Sets the JWT ID (jti) claim to a randomly generated UUID.

takeFrom

inline fun <T> takeFrom(value: T)

Merges all fields from value into this builder, inferring the serializer from the reified type T.

fun <T> takeFrom(serializer: SerializationStrategy<T>, value: T, jsonInstance: Json = Jwt.defaultJsonParser)

Merges all fields from value into this builder, encoded using serializer.