io.ktor.auth / SessionAuthenticationProvider / Configuration

Configuration

class Configuration<T : Any> : Configuration

Session auth configuration

Properties

var challenge: SessionAuthChallenge<T>

A response to send back if authentication failed

Inherited Properties

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

Functions

challenge	`fun challenge(block: SessionAuthChallengeFunction<T>): Unit` `fun challenge(redirectUrl: String): Unit` `fun challenge(redirect: Url): Unit` A response to send back if authentication failed
validate	`fun validate( block: suspend ApplicationCall.(T) -> Principal? ): Unit` 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

Inherited Functions

skipWhen

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

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).