security-key-ktor/dev.kaccelero.plugins/ApiKeyAuthenticationProvider/Configuration

Configuration

class Configuration

Api key auth configuration.

Properties

authScheme

var authScheme: String

Name of the scheme used when challenge fails, see AuthenticationContext.challenge.

headerName

var headerName: String

Name of the header that will be used as a source for the api key.

Functions

challenge

fun challenge(body: ApiKeyAuthChallengeFunction)

A response to send back if authentication failed.

validate

fun validate(body: suspend <Error class: unknown class>.(String) -> <Error class: unknown class>?)

Sets a validation function that will check given API key retrieved from headerName instance and return Principal, or null if credential does not correspond to an authenticated principal.