JwtInstance

Sealed base class for a parsed or constructed JWT token instance.

The two concrete variants correspond to the two main JWT token types defined in the JOSE specifications:

Jws — a signed token (JWS, RFC 7515) with three compact-serialization parts: header.payload.signature.
Jwe — an encrypted token (JWE, RFC 7516) with five compact-serialization parts: header.encryptedKey.iv.ciphertext.tag.

Use compact to obtain the compact-serialized string, or getPayload / getHeader to deserialize the payload or header into a typed object.

Types

Represents a JWE (encrypted) token with five compact-serialization parts.

Represents a JWS (signed) token with one or more signatures.

The JOSE header of the token.

The payload (claims set) of the token.

abstract fun compact(): String

Returns the compact serialization of this token.

inline fun <T> getHeader(jsonInstance: Json = Jwt.defaultJsonParser): T

Deserializes the token header as type T.

fun <T> getHeader(serializer: KSerializer<T>, jsonInstance: Json = Jwt.defaultJsonParser): T

Deserializes the token header using the given serializer.

inline fun <T> getPayload(jsonInstance: Json = Jwt.defaultJsonParser): T

Deserializes the token payload as type T.

fun <T> getPayload(serializer: KSerializer<T>, jsonInstance: Json = Jwt.defaultJsonParser): T

Deserializes the token payload using the given serializer.

open override fun toString(): String