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

Package dev.forst.ktor.apikey

Types

Link copied to clipboard
typealias ApiKeyAuthChallengeFunction = suspend (ApplicationCall) -> Unit
Content copied to clipboard

Alias for function signature that is called when authentication fails.

Link copied to clipboard
typealias ApiKeyAuthenticationFunction = suspend ApplicationCall.(String) -> Principal?
Content copied to clipboard

Alias for function signature that is invoked when verifying header.

Link copied to clipboard
class ApiKeyAuthenticationProvider : AuthenticationProvider
Content copied to clipboard

Represents an API Key authentication provider.

Functions

Link copied to clipboard
fun AuthenticationConfig.apiKey(name: String? = null, configure: ApiKeyAuthenticationProvider.Configuration.() -> Unit)
Content copied to clipboard

Installs API Key authentication mechanism.