Package io.ktor.auth.jwt

Types

JWTAuthenticationProvider
class JWTAuthenticationProvider : AuthenticationProvider

JWT authentication provider that will be registered with the specified name

JWTCredential
class JWTCredential : Credential

Represents a JWT credential consist of the specified payload

JWTPrincipal
class JWTPrincipal : Principal

Represents a JWT principal consist of the specified payload

Type Aliases

JWTAuthChallengeFunction
typealias JWTAuthChallengeFunction = suspend PipelineContext<*, ApplicationCall>.(defaultScheme: String, realm: String) -> Unit

Specifies what to send back if session authentication fails.

JWTConfigureFunction
typealias JWTConfigureFunction = Verification.() -> Unit

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

Functions

jwt
fun Configuration.jwt(
    name: String? = null,
    configure: Configuration.() -> Unit
): Unit

Installs JWT Authentication mechanism