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

Package-level declarations

Types

object ApiKeyAuth

Constants related to API Key authentication.

ApiKeyAuthChallengeFunction

typealias ApiKeyAuthChallengeFunction = suspend (ApplicationCall) -> Unit

Alias for function signature that is called when authentication fails.

ApiKeyAuthenticationFunction

typealias ApiKeyAuthenticationFunction = suspend ApplicationCall.(String) -> Any?

Alias for function signature that is invoked when verifying an API key from a header.

ApiKeyAuthenticationProvider

class ApiKeyAuthenticationProvider : AuthenticationProvider

Represents an API Key authentication provider.

TypedApiKeyAuthConfig

@ExperimentalKtorApi

class TypedApiKeyAuthConfig<P : Any>

Configures a typed API key authentication scheme with principal type P.

Functions

@ExperimentalKtorApi

inline fun <P : Any> apiKey(name: String, configure: TypedApiKeyAuthConfig<P>.() -> Unit): SimpleAuthenticationScheme<P>

Creates a typed API key authentication scheme with principal type P.

fun AuthenticationConfig.apiKey(name: String? = null, configure: ApiKeyAuthenticationProvider.Configuration.() -> Unit)

fun AuthenticationConfig.apiKey(name: String? = null, description: String? = null, configure: ApiKeyAuthenticationProvider.Configuration.() -> Unit)

Installs an API Key authentication mechanism.