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

ApiKeyAuthenticationProvider

class ApiKeyAuthenticationProvider : AuthenticationProvider(source)

Represents an API Key authentication provider.

This provider extracts an API key from a specified header and validates it using the configured authentication function.

Report a problem

Parameters

configuration

the configuration for this authentication provider.

Types

class Configuration : AuthenticationProvider.Config

Configuration for API Key authentication.

Properties

val description: String?

val headerName: String

val name: String?

val skipWhen: List<ApplicationCallPredicate>

Functions

open suspend override fun onAuthenticate(context: AuthenticationContext)