Auth0 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Auth0 Authentication User Profile API

2 actions 2 updates phrasing extends openapi/auth0-user-profile-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['/userinfo'].get

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 User Profile API
  version: 1.0.0
extends: openapi/auth0-user-profile-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['/userinfo'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the logged-in user's profile from a token
      effect: read
      questions:
      - How do I get the signed-in user's profile from their access token?
      - Which scope must the access token have for user info to work?
      instructions:
      - text: Fetch the user profile for access token {access_token}.
        slots:
          access_token: header.access_token
      - text: Get the name and email of whoever owns token {access_token}.
        slots:
          access_token: header.access_token
      method: generated
      generated: '2026-10-01'