smithy.api.HttpApiKeyAuth
See theHttpApiKeyAuth companion object
final case class HttpApiKeyAuth(name: NonEmptyString, in: HttpApiKeyLocations, scheme: Option[NonEmptyString])
An HTTP-specific authentication scheme that sends an arbitrary API key in a header or query string parameter.
Value parameters
- in
-
Defines the location of where the key is serialized. This value can be set to
"header"or"query". - name
-
Defines the name of the HTTP header or query string parameter that contains the API key.
- scheme
-
Defines the security scheme to use on the
Authorizationheader value This can only be set if the "in" property is set toheader.
Attributes
- Companion
- object
- Graph
-
- Supertypes
Members list
In this article