api-morph / OAuthFlowObject
Interface: OAuthFlowObject
Defined in: src/types/openapi.ts:1232
Configuration details for a supported OAuth Flow
See
https://spec.openapis.org/oas/v3.1.1#oauth-flow-object
Indexable
[key: `x-${string}`]: any
This object MAY be extended with Specification Extensions.
Properties
authorizationUrl?
optionalauthorizationUrl:string
Defined in: src/types/openapi.ts:1238
REQUIRED. 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. (Applies to: oauth2 ("implicit", "authorizationCode"))
refreshUrl?
optionalrefreshUrl:string
Defined in: src/types/openapi.ts:1251
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>
Defined in: src/types/openapi.ts:1257
REQUIRED. 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.
tokenUrl?
optionaltokenUrl:string
Defined in: src/types/openapi.ts:1245
REQUIRED. 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. (Applies to: oauth2 ("password", "clientCredentials", "authorizationCode"))