[I] OpenAPIApiKeySecurityScheme3_2
defines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter or as a query parameter), OAuth2’s common flows (implicit, password, application and access code) as defined in RFC6749, and OpenID Connect Discovery.
https://spec.openapis.org/oas/v3.0.4.html#security-scheme-object
Extends
Section titled “Extends”Indexable
Section titled “Indexable”[key: `x-${string}`]: anyProperties
Section titled “Properties”| Property | Type | Description | Inherited from |
|---|---|---|---|
deprecated? | boolean | Specifies that a security scheme is deprecated and SHOULD be transitioned out of usage. See https://spec.openapis.org/oas/v3.2.0.html#security-scheme-object | OpenAPISecuritySchemeBase3_2.deprecated |
description? | string | A short description for security scheme. CommonMark syntax MAY be used for rich text representation. | OpenAPISecuritySchemeBase3_2.description |
in | "header" | "query" | "cookie" | The location of the API key. | OpenAPIApiKeySecurityScheme3_2.in |
name | string | The name of the header, query or cookie parameter to be used. | OpenAPI3ApiKeySecurityScheme.name |
type | "apiKey" | ApiKey | OpenAPI3ApiKeySecurityScheme.type |