required-revoke-token-url
Overview
This rule belongs to the openapi-v3-standards-validation
ruleset and states that:
When the x-revoke-token
extension is used in an OAuth Flow Object, it must include the Url
property that defines the endpoint for revoking tokens.
Property | Value |
---|---|
Enabled | Yes |
Maximum Severity | Error |
Message | Missing Url property in x-revoke-token object of the OAuth Flow Object. |
Code | OPENAPI3STANDARDS_V443 |
Type | Validation |
Rule System | Semantic |
Broad Category | OAuth 2.0 Flows |
Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
Tags | openapi3 openapi standards semantic validation oauth2 revoke token url security security scheme flows token extension |
Suggested Fixes
- Ensure the
x-revoke-token
object contains a validUrl
property. - Verify that the
Url
value is neither null nor empty.
For More Information
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#oauth-flow-object
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#oauth-flows-object
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#security-scheme-object
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#oauth-flow-object
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#oauth-flows-object
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-scheme-object
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#openapi-specification
- https://docs.apimatic.io/rulesets/overview/