ktor-auth/io.ktor.auth/FormAuthenticationProvider/Configuration

Configuration

class Configuration : AuthenticationProvider.Configuration

Form auth provider configuration

Functions

challenge

fun challenge(redirect: Url)

fun challenge(redirectUrl: String)

Configure redirect challenge if authentication failed

fun challenge(function: FormAuthChallengeFunction)

Configure challenge (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(body: suspend ApplicationCall.(UserPasswordCredential) -> Principal?)

Sets a validation function that will check given UserPasswordCredential instance and return Principal, or null if credential does not correspond to an authenticated principal

Properties

challenge

~~var~~ ~~challenge~~: FormAuthChallenge

A response to send back if authentication failed

name

val name: String?

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

passwordParamName

var passwordParamName: String

POST parameter to fetch for a user password

pipeline

val pipeline: AuthenticationPipeline

Authentication pipeline for this provider.

userParamName

var userParamName: String

POST parameter to fetch for a user name