io.ktor.auth / FormAuthenticationProvider / Configuration

Configuration

class Configuration : Configuration

Form auth provider configuration

Properties

challenge	`var challenge: FormAuthChallenge` A response to send back if authentication failed
passwordParamName	`var passwordParamName: String` POST parameter to fetch for a user password
userParamName	`var userParamName: String` POST parameter to fetch for a user name

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(function: FormAuthChallengeFunction): Unit

Configure challenge (response to send back) if authentication failed.

fun challenge(redirectUrl: String): Unit

fun challenge(redirect: Url): Unit

Configure redirect challenge if authentication failed

validate

fun validate(
    body: suspend ApplicationCall.(UserPasswordCredential) -> Principal?
): Unit

Sets a validation function that will check given UserPasswordCredential instance and return Principal, or null if credential 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).