Auth0 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Auth0 Authentication Deprecated > Impersonation API

2 actions 2 updates phrasing extends openapi/auth0-deprecated-impersonation-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['/users/{user_id}/impersonate'].post

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 Deprecated > Impersonation API
  version: 1.0.0
extends: openapi/auth0-deprecated-impersonation-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['/users/{user_id}/impersonate'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a URL to log in as another user
      effect: write
      questions:
      - How can a support admin log in as a user to troubleshoot their account?
      - What does the old impersonation endpoint need to generate a login link?
      instructions:
      - text: Generate an impersonation URL to log in as user {user_id}.
        slots:
          user_id: path.user_id
      - text: Impersonate user {user_id} as admin {impersonator_id} for client {client_id}.
        slots:
          user_id: path.user_id
          impersonator_id: requestBody.impersonator_id
          client_id: requestBody.client_id
      method: generated
      generated: '2026-10-01'