[I] OpenAPI3ApiKeySecurityScheme
defines an ApiKey security scheme that can be used by the operations
Extends
Section titled “Extends”Indexable
Section titled “Indexable”[key: `x-${string}`]: anyProperties
Section titled “Properties”| Property | Type | Description | Inherited from |
|---|---|---|---|
description? | string | A short description for security scheme. CommonMark syntax MAY be used for rich text representation. | OpenAPI3SecuritySchemeBase.description |
in | "header" | "cookie" | "query" | The location of the API key. | - |
name | string | The name of the header, query or cookie parameter to be used. | - |
type | "apiKey" | ApiKey | - |