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

Config

class Config : AuthenticationProvider.Config

A configuration for the basic authentication provider.

Functions

fun skipWhen(predicate: (<ERROR CLASS>) -> 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 <ERROR CLASS>.(UserPasswordCredential) -> Principal?)

Sets a validation function that checks a specified UserPasswordCredential instance and returns UserIdPrincipal in a case of successful authentication or null if authentication fails.

Properties

charset

var charset: Charset?

Specifies the charset to be used. It can be either UTF_8 or null. Setting null turns on a legacy mode (ISO-8859-1).

name

val name: String?

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

realm

var realm: String

Specifies a realm to be passed in the WWW-Authenticate header.