ktor-auth-jwt / io.ktor.auth.jwt / JWTAuthenticationProvider / Configuration

Configuration

class Configuration : Configuration

JWT auth provider configuration

Properties

realm

var realm: String

JWT realm name that will be used during auth challenge

Functions

authHeader

fun authHeader(block: (ApplicationCall) -> HttpAuthHeader?): Unit

Http auth header retrieval function. By default it does parse Authorization header content.

authSchemes

fun authSchemes(defaultScheme: String = "Bearer", vararg additionalSchemes: String): Unit

challenge

fun challenge(block: JWTAuthChallengeFunction): Unit

Specifies what to send back if jwt authentication fails.

validate

fun validate(validate: suspend ApplicationCall.(JWTCredential) -> Principal?): Unit

Apply validate function to every call with JWTCredential

verifier

fun verifier(verifier: JWTVerifier): Unit
fun verifier(verifier: (HttpAuthHeader) -> JWTVerifier?): Unit
fun verifier(jwkProvider: JwkProvider, issuer: String, configure: JWTConfigureFunction = {}): Unit
fun verifier(jwkProvider: JwkProvider, configure: JWTConfigureFunction = {}): Unitfun verifier(issuer: String, audience: String, algorithm: Algorithm, block: Verification.() -> Unit = {}): Unit

Configure verifier using JWTVerifier.

fun verifier(issuer: String, block: JWTConfigureFunction = {}): Unit

Configure verifier using JwkProvider.