Auth0 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Auth0 Management Tickets API

3 actions 3 updates phrasing extends openapi/auth0-tickets-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 3

$.info

$.paths['/tickets/email-verification'].post

$.paths['/tickets/password-change'].post

OpenAPI Overlay

# 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 Tickets API
  version: 1.0.0
extends: openapi/auth0-tickets-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: 2
- target: $.paths['/tickets/email-verification'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an email verification link
      effect: write
      questions:
      - How do I generate a link a user can click to verify their email?
      - Can I set how long an email verification ticket stays valid?
      instructions:
      - text: Create an email verification ticket for user {user_id}.
        slots:
          user_id: requestBody.user_id
      - text: Create a verification link for {user_id} that redirects to {result_url} and lasts {ttl_sec} seconds.
        slots:
          user_id: requestBody.user_id
          result_url: requestBody.result_url
          ttl_sec: requestBody.ttl_sec
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tickets/password-change'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a password reset link
      effect: write
      questions:
      - Can I generate a password change link for a user without sending an email?
      - Is it possible to create a reset ticket by email and connection instead of user ID?
      instructions:
      - text: Create a password change ticket for user {user_id}.
        slots:
          user_id: requestBody.user_id
      - text: Create a password reset link for {email} on connection {connection_id}.
        slots:
          email: requestBody.email
          connection_id: requestBody.connection_id
      method: generated
      generated: '2026-10-01'