ktor-server-auth-api-key/io.ktor.server.auth.apikey/ApiKeyAuthenticationProvider/Configuration

Configuration

class Configuration : AuthenticationProvider.Config(source)

Configuration for API Key authentication.

Report a problem

Parameters

name

optional name for this authentication provider.

description

optional description for this authentication provider.

Properties

var authScheme: String

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

val description: String?

var headerName: String

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

val name: String?

Functions

fun challenge(body: ApiKeyAuthChallengeFunction)

A response to send back if authentication failed.

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

fun validate(body: ApiKeyAuthenticationFunction)

Sets a validation function that will check the given API key retrieved from the headerName header and return an arbitrary principal object (for example, a user or service identity) if authentication succeeds, or null if authentication fails.