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

Config

class Config<T : Any> : AuthenticationProvider.Config

A configuration for the session authentication provider.

Properties

name

val name: String?

is the name of the provider, or null for a default provider.

Functions

challenge

fun challenge(redirect: Url)

fun challenge(redirectUrl: String)

fun challenge(block: SessionAuthChallengeFunction<T>)

Specifies a response to send back if authentication failed.

skipWhen

fun skipWhen(predicate: (ApplicationCall) -> Boolean)

Adds an authentication filter to the list. For every application call the specified predicate is applied and if it returns true then the authentication provider is skipped (no auth required for this call with this provider).

validate

fun validate(block: suspend ApplicationCall.(T) -> Principal?)

Sets a validation function that checks a given T session instance and returns Principal, or null if the session does not correspond to an authenticated principal.