OpenApiSecuritySchemeReference Class

Definition

Namespace:: Microsoft.OpenApi

Assembly:: Microsoft.OpenApi.dll

Package:: Microsoft.OpenApi v3.1.1

Source:: OpenApiSecuritySchemeReference.cs

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 Reference.

public class OpenApiSecuritySchemeReference : Microsoft.OpenApi.BaseOpenApiReferenceHolder<Microsoft.OpenApi.OpenApiSecurityScheme,Microsoft.OpenApi.IOpenApiSecurityScheme,Microsoft.OpenApi.OpenApiReferenceWithDescription>, Microsoft.OpenApi.IOpenApiSecurityScheme, Microsoft.OpenApi.IShallowCopyable<Microsoft.OpenApi.IOpenApiSecurityScheme>

type OpenApiSecuritySchemeReference = class
    inherit BaseOpenApiReferenceHolder<OpenApiSecurityScheme, IOpenApiSecurityScheme, OpenApiReferenceWithDescription>
    interface IOpenApiSecurityScheme
    interface IOpenApiDescribedElement
    interface IOpenApiElement
    interface IOpenApiReadOnlyExtensible
    interface IShallowCopyable<IOpenApiSecurityScheme>
    interface IOpenApiReferenceable
    interface IOpenApiSerializable

Public Class OpenApiSecuritySchemeReference
Inherits BaseOpenApiReferenceHolder(Of OpenApiSecurityScheme, IOpenApiSecurityScheme, OpenApiReferenceWithDescription)
Implements IOpenApiSecurityScheme, IShallowCopyable(Of IOpenApiSecurityScheme)

Inheritance: Object

BaseOpenApiReferenceHolder<OpenApiSecurityScheme,IOpenApiSecurityScheme,OpenApiReferenceWithDescription>
OpenApiSecuritySchemeReference

Implements: IOpenApiDescribedElement IOpenApiElement IOpenApiReadOnlyExtensible IOpenApiReferenceable IOpenApiSecurityScheme IOpenApiSerializable IShallowCopyable<IOpenApiSecurityScheme>

Constructors

Name	Description
OpenApiSecuritySchemeReference(String, OpenApiDocument, String)	Constructor initializing the reference object.

Properties

Name	Description
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.
Deprecated	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	Long description for the example. 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.
RecursiveTarget	Gets the recursively resolved target object. (Inherited from BaseOpenApiReferenceHolder<T,U,V>)
Reference	Reference object. (Inherited from BaseOpenApiReferenceHolder<T,U,V>)
Scheme	REQUIRED. The name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.
Target	Gets the resolved target object. (Inherited from BaseOpenApiReferenceHolder<T,U,V>)
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 (Inherited from BaseOpenApiReferenceHolder<T,U,V>)

Methods

Name	Description
CopyReference(OpenApiReferenceWithDescription)	Copy the reference as a target element with overrides.
CopyReference(V)	Copy the reference as a target element with overrides. (Inherited from BaseOpenApiReferenceHolder<T,U,V>)
CopyReferenceAsTargetElementWithOverrides(IOpenApiSecurityScheme)	Copy the reference as a target element with overrides.
CopyReferenceAsTargetElementWithOverrides(U)	Copy the reference as a target element with overrides. (Inherited from BaseOpenApiReferenceHolder<T,U,V>)
CreateShallowCopy()	Create a shallow copy of the current instance.
SerializeAsV2(IOpenApiWriter)	Serialize Open API element to v2.0. (Inherited from BaseOpenApiReferenceHolder<T,U,V>)
SerializeAsV3(IOpenApiWriter)	Serialize Open API element to v3.0. (Inherited from BaseOpenApiReferenceHolder<T,U,V>)
SerializeAsV31(IOpenApiWriter)	Serialize OpenAPI element into v3.1 (Inherited from BaseOpenApiReferenceHolder<T,U,V>)
SerializeAsV32(IOpenApiWriter)	Serialize OpenAPI element into v3.2 (Inherited from BaseOpenApiReferenceHolder<T,U,V>)

Extension Methods

Name	Description
Validate(IOpenApiElement, ValidationRuleSet)	Validate element and all child elements

Applies to

Share via