Auth0 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Auth0 Authentication DB Connections API

3 actions 3 updates phrasing extends openapi/auth0-db-connections-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['/dbconnections/change_password'].post

$.paths['/dbconnections/signup'].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 Authentication DB Connections API
  version: 1.0.0
extends: openapi/auth0-db-connections-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['/dbconnections/change_password'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a password reset email
      effect: write
      questions:
      - How do I email a user a link to reset their password?
      - Can the reset email use organization-specific branding?
      instructions:
      - text: Send a password reset email to {email} on connection {connection}.
        slots:
          email: requestBody.email
          connection: requestBody.connection
      - text: Email {email} a change-password link for organization {organization}.
        slots:
          email: requestBody.email
          organization: requestBody.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dbconnections/signup'].post
  update:
    x-apievangelist-phrasing:
      intent: Sign up a new user to a database connection
      effect: write
      questions:
      - Can I create a user account from my own signup form with an email and password?
      - Does the signup endpoint work for social or enterprise connections, or only database ones?
      instructions:
      - text: Sign up {email} with password {password} on database connection {connection}.
        slots:
          email: requestBody.email
          password: requestBody.password
          connection: requestBody.connection
      - text: Register user {email} named {name} in connection {connection} for client {client_id} with password {password}.
        slots:
          email: requestBody.email
          name: requestBody.name
          connection: requestBody.connection
          client_id: requestBody.client_id
          password: requestBody.password
      method: generated
      generated: '2026-10-01'