ktor-server-auth

3.3.0

ktor-server-auth/io.ktor.server.auth/SessionAuthenticationProvider

SessionAuthenticationProvider

class SessionAuthenticationProvider<T : Any> : AuthenticationProvider(source)

A session-based Authentication provider.

Report a problem

See also

Types

object Companion

class Config<T : Any> : AuthenticationProvider.Config

A configuration for the session authentication provider.

Properties

val name: String?

A provider name or null for a default provider.

val skipWhen: List<ApplicationCallPredicate>

Authentication filters specifying if authentication is required for a particular ApplicationCall.

val type: KClass<T>

of session

Functions

open suspend override fun onAuthenticate(context: AuthenticationContext)

Authenticates a request based on AuthenticationContext. Implementations should either add a new AuthenticationContext.principal for successful authentication or register AuthenticationContext.challenge for failed ones.