Auth0 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Auth0 Management Token Exchange Profiles API

6 actions 6 updates phrasing extends openapi/auth0-token-exchange-profiles-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 6

$.info
$.paths['/token-exchange-profiles'].get
$.paths['/token-exchange-profiles'].post
$.paths['/token-exchange-profiles/{id}'].get
$.paths['/token-exchange-profiles/{id}'].delete
$.paths['/token-exchange-profiles/{id}'].patch

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 Token Exchange Profiles API
  version: 1.0.0
extends: openapi/auth0-token-exchange-profiles-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: 5
- target: $.paths['/token-exchange-profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List Token Exchange Profiles
      effect: read
      questions:
      - Which custom token exchange profiles are configured in my tenant?
      - Can I page through token exchange profiles with a cursor?
      instructions:
      - text: List my Token Exchange Profiles.
      - text: List {take} token exchange profiles from cursor {from}.
        slots:
          take: query.take
          from: query.from
      method: generated
      generated: '2026-10-01'
- target: $.paths['/token-exchange-profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Token Exchange Profile
      effect: write
      questions:
      - How do I let apps exchange an external token for one issued by my tenant?
      - What Action and subject token type does a token exchange profile need?
      instructions:
      - text: Create token exchange profile {name} for subject token type {subject_token_type} using Action {action_id} and type {type}.
        slots:
          name: requestBody.name
          subject_token_type: requestBody.subject_token_type
          action_id: requestBody.action_id
          type: requestBody.type
      - text: Set up a {type} token exchange profile called {name} validated by Action {action_id} for {subject_token_type}.
        slots:
          type: requestBody.type
          name: requestBody.name
          action_id: requestBody.action_id
          subject_token_type: requestBody.subject_token_type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/token-exchange-profiles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Token Exchange Profile
      effect: read
      questions:
      - Which Action validates tokens for a given exchange profile?
      - Can I look up one token exchange profile by ID?
      instructions:
      - text: Show me token exchange profile {id}.
        slots:
          id: path.id
      - text: Get the subject token type of exchange profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/token-exchange-profiles/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Token Exchange Profile
      effect: destructive
      questions:
      - How do I turn off a custom token exchange I set up?
      - Can I delete a token exchange profile by ID?
      instructions:
      - text: Delete token exchange profile {id}.
        slots:
          id: path.id
      - text: Remove the custom token exchange profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/token-exchange-profiles/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or retarget a Token Exchange Profile
      effect: write
      questions:
      - Can I change the subject token type on an existing exchange profile?
      - Which fields of a token exchange profile can be edited later?
      instructions:
      - text: Rename token exchange profile {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Change the subject token type of profile {id} to {subject_token_type}.
        slots:
          id: path.id
          subject_token_type: requestBody.subject_token_type
      method: generated
      generated: '2026-10-01'