http4k-contract/org.http4k.contract.security/ApiKeySecurity

ApiKeySecurity

class ApiKeySecurity<out T> : Security

Checks the presence of the named Api Key parameter. Filter returns 401 if Api-Key is not found in request.

Default implementation of ApiKey. Includes an option to NOT authorise OPTIONS requests, which is currently not enabled for OpenAPI.

Constructors

constructor(param: Lens<Request, T>, validateKey: (T) -> Boolean, authorizeOptionsRequests: Boolean = true, name: String = "api_key")

Types

object Companion

Properties

open override val filter: Filter

val name: String

val param: Lens<Request, T>

Functions

fun Security.and(that: Security): Security

fun Security.or(that: Security): Security