Auth0 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Auth0 Management Connection Profiles API

8 actions 8 updates phrasing extends openapi/auth0-connection-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['/connection-profiles'].get
$.paths['/connection-profiles'].post
$.paths['/connection-profiles/templates'].get
$.paths['/connection-profiles/templates/{id}'].get
$.paths['/connection-profiles/{id}'].get
$.paths['/connection-profiles/{id}'].delete
$.paths['/connection-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 Connection Profiles API
  version: 1.0.0
extends: openapi/auth0-connection-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['/connection-profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List connection profiles
      effect: read
      questions:
      - Which connection profiles exist in my tenant?
      - Can I page through connection profiles with a checkpoint?
      instructions:
      - text: List my connection profiles.
      - text: Show {take} connection profiles starting from {from}.
        slots:
          take: query.take
          from: query.from
      method: generated
      generated: '2026-10-01'
- target: $.paths['/connection-profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a connection profile
      effect: write
      questions:
      - How do I create a connection profile to standardize new enterprise connections?
      - Can I set a naming prefix template for connections created from a profile?
      instructions:
      - text: Create a connection profile named {name}.
        slots:
          name: requestBody.name
      - text: Create connection profile {name} with prefix template {connection_name_prefix_template}.
        slots:
          name: requestBody.name
          connection_name_prefix_template: requestBody.connection_name_prefix_template
      method: generated
      generated: '2026-10-01'
- target: $.paths['/connection-profiles/templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List connection profile templates
      effect: read
      questions:
      - What connection profile templates are available to start from?
      - Are there predefined templates for connection profiles?
      instructions:
      - text: List connection profile templates.
      - text: Show the available templates for connection profiles.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/connection-profiles/templates/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a connection profile template
      effect: read
      questions:
      - Can I look at what one connection profile template contains?
      - What settings come with a given profile template?
      instructions:
      - text: Show connection profile template {id}.
        slots:
          id: path.id
      - text: Get the contents of profile template {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/connection-profiles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a connection profile
      effect: read
      questions:
      - Can I see the details of one connection profile I created?
      - Which features are enabled on a specific connection profile?
      instructions:
      - text: Show connection profile {id}.
        slots:
          id: path.id
      - text: Get the enabled features of connection profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/connection-profiles/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a connection profile
      effect: destructive
      questions:
      - How do I delete a connection profile?
      - Can I remove a connection profile I no longer use?
      instructions:
      - text: Delete connection profile {id}.
        slots:
          id: path.id
      - text: Remove profile {id} from my connection profiles.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/connection-profiles/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a connection profile
      effect: write
      questions:
      - Can I rename an existing connection profile or change its features?
      - How do I change the strategy overrides on a connection profile?
      instructions:
      - text: Rename connection profile {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Set enabled features of connection profile {id} to {enabled_features}.
        slots:
          id: path.id
          enabled_features: requestBody.enabled_features
      method: generated
      generated: '2026-10-01'