ktor-server-auth/io.ktor.server.auth/AuthenticationScheme

AuthenticationScheme

class AuthenticationScheme<P : Any, C>(source)

The provider is registered lazily when the scheme is first used by authenticateWith. Reusing the same provider object, including through mapPrincipal or orAnonymous, reuses the existing application registration. Creating a different provider with the same name fails fast because provider names are application-wide identifiers.

Report a problem

Type Parameters

the principal type produced by this scheme.

the intrinsic extension context supplied to authenticated routes.

Types

Companion

object Companion

Properties

name

val name: String

name that identifies this authentication scheme.

onUnauthorized

val onUnauthorized: UnauthorizedHandler?

default failure handler for routes that use the scheme. A route-level handler passed to authenticateWith overrides this value.

Functions

applyTransport

@ExperimentalKtorApi

context(pluginConfig: SessionsConfig)
fun <S : Any> SessionAuthenticationScheme<S, *>.applyTransport()

Applies this scheme's configured TypedSessionAuthConfig.transport to a SessionsConfig.

clearSession

@ExperimentalKtorApi

context(context: RoutingContext)
fun <S : Any, P : Any> SessionAuthenticationScheme<S, P>.clearSession()

Clears a session for this scheme.

mapPrincipal

@ExperimentalKtorApi

inline fun <P : Any, R : Any, C> AuthenticationScheme<P, C>.mapPrincipal(noinline transform: suspend RoutingContext.(P) -> R?): AuthenticationScheme<R, C>

Returns a scheme that produces R by transforming every successfully resolved principal of type P.

orAnonymous

@ExperimentalKtorApi

inline fun <CP : Any, P : AP, AP : CP> SimpleAuthenticationScheme<P>.orAnonymous(noinline fallback: suspend RoutingContext.() -> AP): SimpleAuthenticationScheme<CP>

Returns a scheme that accepts anonymous requests when no credentials are provided.

setSession

@ExperimentalKtorApi

context(context: RoutingContext)
fun <S : Any, P : Any> SessionAuthenticationScheme<S, P>.setSession(value: S)

Sets a session value for this scheme.