Share via


OpenApiOAuthFlow Class

Definition

OAuth Flow Object.

public class OpenApiOAuthFlow : Microsoft.OpenApi.Interfaces.IOpenApiExtensible, Microsoft.OpenApi.Interfaces.IOpenApiSerializable
type OpenApiOAuthFlow = class
    interface IOpenApiSerializable
    interface IOpenApiElement
    interface IOpenApiExtensible
Public Class OpenApiOAuthFlow
Implements IOpenApiExtensible, IOpenApiSerializable
Inheritance
OpenApiOAuthFlow
Implements

Constructors

OpenApiOAuthFlow()

Parameterless constructor

OpenApiOAuthFlow(OpenApiOAuthFlow)

Initializes a copy of an OpenApiOAuthFlow object

Properties

AuthorizationUrl

REQUIRED. The authorization URL to be used for this flow. Applies to implicit and authorizationCode OAuthFlow.

Extensions

Specification Extensions.

RefreshUrl

The URL to be used for obtaining refresh tokens.

Scopes

REQUIRED. A map between the scope name and a short description for it.

TokenUrl

REQUIRED. The token URL to be used for this flow. Applies to password, clientCredentials, and authorizationCode OAuthFlow.

Methods

SerializeAsV2(IOpenApiWriter)

Serialize OpenApiOAuthFlow to Open Api v2.0

SerializeAsV3(IOpenApiWriter)

Serialize OpenApiOAuthFlow to Open Api v3.0

Extension Methods

Validate(IOpenApiElement, ValidationRuleSet)

Validate element and all child elements

Applies to