Auth0 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Auth0 Management Grants API

4 actions 4 updates phrasing extends openapi/auth0-grants-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 4

$.info
$.paths['/grants'].get
$.paths['/grants'].delete
$.paths['/grants/{id}'].delete

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 Grants API
  version: 1.0.0
extends: openapi/auth0-grants-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: 3
- target: $.paths['/grants'].get
  update:
    x-apievangelist-phrasing:
      intent: List user consent grants
      effect: read
      questions:
      - Which apps has a user granted consent to?
      - Can I filter grants by application or audience?
      instructions:
      - text: List all grants.
      - text: List grants for user {user_id}.
        slots:
          user_id: query.user_id
      - text: Show grants for client {client_id} and audience {audience}.
        slots:
          client_id: query.client_id
          audience: query.audience
      method: generated
      generated: '2026-10-01'
- target: $.paths['/grants'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete all grants for a user
      effect: destructive
      questions:
      - How do I revoke every consent grant a user has given?
      - Can I delete grants by user ID instead of grant ID?
      instructions:
      - text: Delete grants for user {user_id}.
        slots:
          user_id: query.user_id
      - text: Revoke all consent grants of user {user_id}.
        slots:
          user_id: query.user_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/grants/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a grant by ID
      effect: destructive
      questions:
      - Can I revoke one specific grant by its ID?
      - How do I remove a single consent grant?
      instructions:
      - text: Delete grant {id}.
        slots:
          id: path.id
      - text: Revoke consent grant {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'