IOpenApiAuthenticationOptions interface

Defines options for OpenAPI authentication schemes.

public interface IOpenApiAuthenticationOptions

Members

name description
Deprecated { get; set; } Specifies that a security scheme is deprecated and SHOULD be transitioned out of usage. Note: This field is supported in OpenAPI 3.2.0+. For earlier versions, it will be serialized as x-oai-deprecated extension.
Description { get; set; } Optional description for the security scheme in OpenAPI documentation.
DocumentationId { get; set; } Optional documentation identifiers associated with this authentication scheme.
GlobalScheme { get; set; } If true, this security scheme is applied globally in OpenAPI documentation.
const DefaultSchemeName Default authentication scheme name.

See Also