[I] ApiKeyAuth
An API key is a token that a client provides when making API calls. The key can be sent in the query string:
GET /something?api_key=abcdef12345or as a request header
GET /something HTTP/1.1X-API-Key: abcdef12345or as a cookie
GET /something HTTP/1.1Cookie: X-API-KEY=abcdef12345Extends
Section titled “Extends”Type Parameters
Section titled “Type Parameters”| Type Parameter |
|---|
TLocation extends ApiKeyLocation |
TName extends string |
Properties
Section titled “Properties”| Property | Modifier | Type | Description | Inherited from |
|---|---|---|---|---|
description? | public | string | Documentation from the authentication model, when provided. | HttpAuthBase.description |
id | public | string | Scheme identifier, initially derived from the model name or authentication type. Service authentication resolution disambiguates conflicting identifiers. | HttpAuthBase.id |
in | public | TLocation | Request location in which the client must send the key. | - |
model | readonly | Model | Model that defined the authentication | HttpAuthBase.model |
name | public | TName | Header, query parameter, or cookie name carrying the key. | - |
type | public | "apiKey" | Identifies an API-key scheme rather than an Authorization-header scheme. | - |