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

TypedApiKeyAuthConfig

@ExperimentalKtorApi

class TypedApiKeyAuthConfig<P : Any>(source)

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

Report a problem

Properties

var description: String?

Human-readable description of this authentication scheme.

var headerName: String

Header name used to read the API key.

var onUnauthorized: UnauthorizedHandler?

Default handler for authentication failures.

Functions

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

Sets a validation function for the API key string read from headerName.