Interface OAuthFlowObject

Configuration details for a supported OAuth Flow

See

https://spec.openapis.org/oas/latest.html#oauth-flow-object

interface OAuthFlowObject {
    authorizationUrl?: string;
    refreshUrl?: string;
    scopes: Record<string, string>;
    tokenUrl?: string;
}

Hierarchy (view full)

Properties

authorizationUrl? refreshUrl? scopes tokenUrl?

Properties

Optional authorizationUrl

authorizationUrl?: string

The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.

Optional refreshUrl

refreshUrl?: string

The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.

scopes

scopes: Record<string, string>

The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty.

Optional tokenUrl

tokenUrl?: string

The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.

Settings

Member Visibility

Theme

On This Page

authorizationUrlrefreshUrlscopestokenUrl