OpenApiSecurityScheme Class

Reference

Definition

Namespace:: Microsoft.OpenApi.Models

Assembly:: Microsoft.OpenApi.dll

Package:: Microsoft.OpenApi v1.6.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Security Scheme Object.

public class OpenApiSecurityScheme : Microsoft.OpenApi.Interfaces.IOpenApiExtensible, Microsoft.OpenApi.Interfaces.IOpenApiReferenceable

type OpenApiSecurityScheme = class
    interface IOpenApiSerializable
    interface IOpenApiElement
    interface IOpenApiReferenceable
    interface IOpenApiExtensible

Public Class OpenApiSecurityScheme
Implements IOpenApiExtensible, IOpenApiReferenceable

Inheritance: Object
OpenApiSecurityScheme

Implements: IOpenApiElement IOpenApiExtensible IOpenApiReferenceable IOpenApiSerializable

Constructors

OpenApiSecurityScheme()	Parameterless constructor
OpenApiSecurityScheme(OpenApiSecurityScheme)	Initializes a copy of OpenApiSecurityScheme object

Properties

BearerFormat	A 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	A short description for security scheme. CommonMark syntax MAY be used for rich text representation.
Extensions	Specification Extensions.
Flows	REQUIRED. An object containing configuration information for the flow types supported.
In	REQUIRED. The location of the API key. Valid values are "query", "header" or "cookie".
Name	REQUIRED. The name of the header, query or cookie parameter to be used.
OpenIdConnectUrl	REQUIRED. OpenId Connect URL to discover OAuth2 configuration values.
Reference	Reference object.
Scheme	REQUIRED. The name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.
Type	REQUIRED. The type of the security scheme. Valid values are "apiKey", "http", "oauth2", "openIdConnect".
UnresolvedReference	Indicates if object is populated with data or is just a reference to the data

Methods

SerializeAsV2(IOpenApiWriter)	Serialize OpenApiSecurityScheme to Open Api v2.0
SerializeAsV2WithoutReference(IOpenApiWriter)	Serialize to OpenAPI V2 document without using reference.
SerializeAsV3(IOpenApiWriter)	Serialize OpenApiSecurityScheme to Open Api v3.0
SerializeAsV3WithoutReference(IOpenApiWriter)	Serialize to OpenAPI V3 document without using reference.

Extension Methods

Validate(IOpenApiElement, ValidationRuleSet)	Validate element and all child elements
ResolveReference(IOpenApiReferenceable, JsonPointer)	Resolves a JSON Pointer with respect to an element, returning the referenced element.

Applies to

Share via