Auth0 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Auth0 Authentication Revoke Refresh Token API

2 actions 2 updates phrasing extends openapi/auth0-revoke-refresh-token-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Auth0's API. It is a proposal applied on top of the contract, not a document Auth0 publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info
$.paths['/oauth/revoke'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Auth0 Authentication Revoke Refresh Token API
  version: 1.0.0
extends: openapi/auth0-revoke-refresh-token-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 1
- target: $.paths['/oauth/revoke'].post
  update:
    x-apievangelist-phrasing:
      intent: Revoke a compromised refresh token
      effect: destructive
      questions:
      - What should I do if a user's refresh token has been leaked?
      - Does revoking a refresh token also revoke other tokens from the same grant?
      instructions:
      - text: Revoke refresh token {token} for client {client_id}.
        slots:
          token: requestBody.token
          client_id: requestBody.client_id
      - text: Invalidate refresh token {token} issued to app {client_id} using client secret {client_secret}.
        slots:
          token: requestBody.token
          client_id: requestBody.client_id
          client_secret: requestBody.client_secret
      method: generated
      generated: '2026-10-01'