javalin-security-api-key/io.github.mzlnk.javalin.security.apikey/ApiKeyResolver/Companion

Companion

object Companion

Properties

Link copied to clipboard
@JvmStatic
val DEFAULT: ApiKeyResolver

The default resolver: header with the standard X-Api-Key header.

Functions

Link copied to clipboard
@JvmStatic
fun cookie(name: String): ApiKeyResolver

Extracts the API key from the cookie named name.

Link copied to clipboard
@JvmStatic
@JvmOverloads
fun header(headerName: String = "X-Api-Key"): ApiKeyResolver

Extracts the API key from headerName (defaults to X-Api-Key).

Link copied to clipboard
@JvmStatic
fun query(paramName: String): ApiKeyResolver

Extracts the API key from the query parameter named paramName.