ApiKeyAuth

A header field for API key authentication.

Properties

open override val field: String

open override val fields: List<String>

The fields for this header field.

Creates a pair of header fields as HeaderPairField.

infix fun <T> HeaderField<T>.bind(value: T): T

Binds a value to a HeaderField for readable typed header construction. This is a pass-through that ensures the value matches the field type.

Creates a Headers object from the given value.

context(_: Raise<Issue>)
open override fun decode(headers: Headers): String

Decodes the API key from Headers.

open override fun flatten(): List<HeaderField<*>>

Flattens the HeaderField into its constituent fields.

Marks a header field as optional.