vertx / io.vertx.kotlin.ext.auth.jwt / JWTOptions

JWTOptions

fun JWTOptions(algorithm: String? = null, audience: Iterable<String>? = null, audiences: Iterable<String>? = null, expiresInMinutes: Long? = null, expiresInSeconds: Long? = null, headers: Map<String, String>? = null, issuer: String? = null, noTimestamp: Boolean? = null, permissions: Iterable<String>? = null, subject: String? = null): JWTOptions

A function providing a DSL for building io.vertx.ext.auth.jwt.JWTOptions objects.

Options related to creation of new tokens.

If any expiresInMinutes, audience, subject, issuer are not provided, there is no default. The jwt generated won't include those properties in the payload.

Generated JWTs will include an iat claim by default unless noTimestamp is specified.

Parameters

algorithm - The algorithm to use, it should be one of the alias HS256,HS384,HS512,RS256,RS384,RS512,ES256,ES384,ES512

audience - The target audience of this token

audiences - The target audience of this token

expiresInMinutes - The expiration time for the token in minutes

expiresInSeconds - The expiration time for the token in seconds

headers -

issuer - The issuer of this token

noTimestamp - Disable the generation of issued at claim

permissions - The permissions of this token.

subject - The subject of this token