ktor-auth/io.ktor.auth/SessionAuthenticationProvider/Configuration

Configuration

class Configuration<T : Any> : AuthenticationProvider.Configuration

Session auth configuration

Functions

challenge

fun challenge(redirect: Url)

fun challenge(redirectUrl: String)

fun challenge(block: SessionAuthChallengeFunction<T>)

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 will check given T session instance and return Principal, or null if the session does not correspond to an authenticated principal

Properties

challenge

~~var~~ ~~challenge~~: SessionAuthChallenge<T>

A response to send back if authentication failed

name

val name: String?

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

pipeline

val pipeline: AuthenticationPipeline

Authentication pipeline for this provider.