multipaz/org.multipaz.webtoken/WebTokenClaim

WebTokenClaim

abstract class WebTokenClaim<T : Any>(val kType: KClass<T>, val strKey: String, val numKey: Long? = null, val header: Boolean = false)

Helper object to represent a web token (CWT or JWT) claim.

Most of the claims go to the body of the web token, but some must be in the header. In JWT all claims use string keys, but in CWT some use numeric keys.

Parameters

kType

value type for the claim

strKey

string key for the claim

numKey

numeric key for the claim (in any)

header

true if the claim must be in the header

Inheritors

Constructors

WebTokenClaim

constructor(kType: KClass<T>, strKey: String, numKey: Long? = null, header: Boolean = false)

Types

Ath

object Ath : WebTokenClaim<String>

Authorization token (ath) claim.

Aud

object Aud : WebTokenClaim<String>

Audience (aud) claim.

Challenge

object Challenge : WebTokenClaim<String>

Challenge (challenge) claim.

Companion

object Companion

Cti

object Cti : WebTokenClaim<ByteString>

CWT identifier (cti) claim.

Exp

object Exp : WebTokenClaim<Instant>

Expiration (exp) claim.

Htm

object Htm : WebTokenClaim<String>

HTTP method (htm) claim.

Htu

object Htu : WebTokenClaim<String>

HTTP url (htu) claim.

Iat

object Iat : WebTokenClaim<Instant>

Issued-at (iat) claim.

Iss

object Iss : WebTokenClaim<String>

Issuer (iss) claim.

Jti

object Jti : WebTokenClaim<String>

JWT identifier (jti) claim.

Nbf

object Nbf : WebTokenClaim<Instant>

Not-before (nbf) claim.

Nonce

object Nonce : WebTokenClaim<String>

Nonce (nonce) claim.

Sub

object Sub : WebTokenClaim<String>

Subject (sub) claim.

Typ

object Typ : WebTokenClaim<String>

Token type (typ) claim.

Properties

header

val header: Boolean = false

kType

val kType: KClass<T>

numKey

val numKey: Long? = null

strKey

val strKey: String