Auth0 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Auth0 Management Refresh Tokens API

6 actions 6 updates phrasing extends openapi/auth0-refresh-tokens-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 6

$.info
$.paths['/refresh-tokens'].get
$.paths['/refresh-tokens/revoke'].post
$.paths['/refresh-tokens/{id}'].get
$.paths['/refresh-tokens/{id}'].delete
$.paths['/refresh-tokens/{id}'].patch

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 Management Refresh Tokens API
  version: 1.0.0
extends: openapi/auth0-refresh-tokens-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: 5
- target: $.paths['/refresh-tokens'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's refresh tokens
      effect: read
      questions:
      - Which refresh tokens does a particular user currently hold?
      - Can I narrow a user's refresh tokens to one application?
      instructions:
      - text: List refresh tokens for user {user_id}.
        slots:
          user_id: query.user_id
      - text: List refresh tokens for user {user_id} issued to client {client_id}.
        slots:
          user_id: query.user_id
          client_id: query.client_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/refresh-tokens/revoke'].post
  update:
    x-apievangelist-phrasing:
      intent: Revoke refresh tokens in bulk
      effect: destructive
      questions:
      - How do I sign a user out of every device by killing all their refresh tokens?
      - Can I revoke every refresh token issued to one application?
      instructions:
      - text: Revoke all refresh tokens for user {user_id}.
        slots:
          user_id: requestBody.user_id
      - text: Revoke all refresh tokens issued to client {client_id}.
        slots:
          client_id: requestBody.client_id
      - text: Revoke the refresh tokens with IDs {ids}.
        slots:
          ids: requestBody.ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/refresh-tokens/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of a refresh token
      effect: read
      questions:
      - When was a specific refresh token created and which app is it for?
      - Can I inspect one refresh token by its ID?
      instructions:
      - text: Show me refresh token {id}.
        slots:
          id: path.id
      - text: Get the client and expiry of refresh token {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/refresh-tokens/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a single refresh token
      effect: destructive
      questions:
      - How do I invalidate one specific refresh token?
      - Can I delete a single refresh token without affecting the user's others?
      instructions:
      - text: Delete refresh token {id}.
        slots:
          id: path.id
      - text: Remove just the one refresh token {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/refresh-tokens/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a refresh token's metadata
      effect: write
      questions:
      - Can I attach custom metadata to an existing refresh token?
      - What part of a refresh token can be updated?
      instructions:
      - text: Set metadata {refresh_token_metadata} on refresh token {id}.
        slots:
          refresh_token_metadata: requestBody.refresh_token_metadata
          id: path.id
      - text: Update the metadata of refresh token {id} to {refresh_token_metadata}.
        slots:
          id: path.id
          refresh_token_metadata: requestBody.refresh_token_metadata
      method: generated
      generated: '2026-10-01'