OpenAPI · Schema
OpenAPI OAuth Flow Object
Configuration details for a supported OAuth Flow.
DocumentationRESTSpecification
Properties
| Name | Type | Description |
|---|---|---|
| authorizationUrl | string | The authorization URL for this flow. |
| tokenUrl | string | The token URL for this flow. |
| refreshUrl | string | The URL to be used for obtaining refresh tokens. |
| scopes | object | The available scopes for the OAuth2 security scheme. |
JSON Schema
{
"$id": "openapi-oauth-flow.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "OpenAPI OAuth Flow Object",
"description": "Configuration details for a supported OAuth Flow.",
"type": "object",
"required": [
"scopes"
],
"properties": {
"authorizationUrl": {
"type": "string",
"format": "uri",
"description": "The authorization URL for this flow."
},
"tokenUrl": {
"type": "string",
"format": "uri",
"description": "The token URL for this flow."
},
"refreshUrl": {
"type": "string",
"format": "uri",
"description": "The URL to be used for obtaining refresh tokens."
},
"scopes": {
"type": "object",
"description": "The available scopes for the OAuth2 security scheme.",
"additionalProperties": {
"type": "string"
}
}
},
"patternProperties": {
"^x-": {}
},
"additionalProperties": false
}