Auth0 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Auth0 Management User Attribute Profiles API

8 actions 8 updates phrasing extends openapi/auth0-user-attribute-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 8

$.info
$.paths['/user-attribute-profiles'].get
$.paths['/user-attribute-profiles'].post
$.paths['/user-attribute-profiles/templates'].get
$.paths['/user-attribute-profiles/templates/{id}'].get
$.paths['/user-attribute-profiles/{id}'].get
$.paths['/user-attribute-profiles/{id}'].delete
$.paths['/user-attribute-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 User Attribute Profiles API
  version: 1.0.0
extends: openapi/auth0-user-attribute-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: 7
- target: $.paths['/user-attribute-profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List user attribute profiles
      effect: read
      questions:
      - Which user attribute profiles exist in my Auth0 tenant?
      - Can I page through user attribute profiles with checkpoint pagination?
      instructions:
      - text: List my user attribute profiles.
      - text: Show the next {take} user attribute profiles.
        slots:
          take: query.take
      method: generated
      generated: '2026-10-01'
- target: $.paths['/user-attribute-profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a user attribute profile
      effect: write
      questions:
      - How do I define a new set of user attributes as a profile?
      - Can I set which attribute maps to the user ID in a new profile?
      instructions:
      - text: Create a user attribute profile named {name} with attributes {user_attributes}.
        slots:
          name: requestBody.name
          user_attributes: requestBody.user_attributes
      - text: Create profile {name} with attributes {user_attributes} and user ID mapping {user_id}.
        slots:
          name: requestBody.name
          user_attributes: requestBody.user_attributes
          user_id: requestBody.user_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/user-attribute-profiles/templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List user attribute profile templates
      effect: read
      questions:
      - What starter templates are available for user attribute profiles?
      - Are there predefined attribute profile templates I can begin from?
      instructions:
      - text: List the user attribute profile templates.
      - text: Show me all available attribute profile templates.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/user-attribute-profiles/templates/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user attribute profile template
      effect: read
      questions:
      - Which attributes does a particular profile template include?
      - Can I look at one attribute profile template in detail?
      instructions:
      - text: Get user attribute profile template {id}.
        slots:
          id: path.id
      - text: Show the attributes defined in template {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/user-attribute-profiles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user attribute profile
      effect: read
      questions:
      - What attributes are in one of my user attribute profiles?
      - Can I fetch a single user attribute profile by its ID?
      instructions:
      - text: Get user attribute profile {id}.
        slots:
          id: path.id
      - text: Show the details of my attribute profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/user-attribute-profiles/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a user attribute profile
      effect: destructive
      questions:
      - Can I delete a user attribute profile I created?
      - What's the way to remove an unused attribute profile?
      instructions:
      - text: Delete user attribute profile {id}.
        slots:
          id: path.id
      - text: Remove the attribute profile {id} from my tenant.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/user-attribute-profiles/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a user attribute profile
      effect: write
      questions:
      - How do I add or change attributes in an existing profile?
      - Can I rename a user attribute profile?
      instructions:
      - text: Rename user attribute profile {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Set the attributes of profile {id} to {user_attributes}.
        slots:
          id: path.id
          user_attributes: requestBody.user_attributes
      method: generated
      generated: '2026-10-01'