Skip to content

[I] OpenAPI3HttpSecurityScheme

defines an Http security scheme that can be used by the operations

Extends

Indexable

[key: `x-${string}`]: any

Properties

PropertyTypeDescriptionInherited from
bearerFormat?stringA hint to the client to identify how the bearer token is formatted. Bearer tokens are usually generated by an authorization server, so this information is primarily for documentation purposes.-
description?stringA short description for security scheme. CommonMark syntax MAY be used for rich text representation.OpenAPI3SecuritySchemeBase.description
schemestringhe name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.-
type"http"HTTP-