ktor-auth-jwt/io.ktor.auth.jwt

Package io.ktor.auth.jwt

Types

Link copied to clipboard
typealias JWTAuthChallengeFunction = suspend PipelineContext<*, ApplicationCall>.(defaultScheme: String, realm: String) -> Unit
Content copied to clipboard

Specifies what to send back if session authentication fails.

Link copied to clipboard
class JWTAuthenticationProvider : AuthenticationProvider
Content copied to clipboard

JWT authentication provider that will be registered with the specified name

Link copied to clipboard
typealias JWTConfigureFunction = Verification.() -> Unit
Content copied to clipboard

JWT verifier configuration function. It is applied on the verifier builder.

Link copied to clipboard
class JWTCredential(payload: Payload) : JWTPayloadHolder, Credential
Content copied to clipboard

Represents a JWT credential consist of the specified payload

Link copied to clipboard
abstract class JWTPayloadHolder(payload: Payload)
Content copied to clipboard

Shortcut functions for standard registered JWT Claims

Link copied to clipboard
class JWTPrincipal(payload: Payload) : JWTPayloadHolder, Principal
Content copied to clipboard

Represents a JWT principal consist of the specified payload

Functions

Link copied to clipboard
fun Authentication.Configuration.jwt(name: String? = null, configure: JWTAuthenticationProvider.Configuration.() -> Unit)
Content copied to clipboard

Installs JWT Authentication mechanism