ktor-api-key/dev.forst.ktor.apikey/ApiKeyAuthenticationProvider/Configuration

Configuration

class Configuration : AuthenticationProvider.Config

Api key auth configuration.

Functions

challenge

fun challenge(body: ApiKeyAuthChallengeFunction)

A response to send back if authentication failed.

skipWhen

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

validate

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

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.

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.

name

val name: String?

Sources

Ktor API Key Authentication Provider source