Auth0 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Auth0 Management Groups API

5 actions 5 updates phrasing extends openapi/auth0-groups-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 5

$.info

$.paths['/groups'].get

$.paths['/groups/{id}'].get

$.paths['/groups/{id}'].delete

$.paths['/groups/{id}/members'].get

OpenAPI Overlay

# 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 Groups API
  version: 1.0.0
extends: openapi/auth0-groups-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: 4
- target: $.paths['/groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List groups in the tenant
      effect: read
      questions:
      - Which user groups exist in my Auth0 tenant?
      - Can I find groups that came from a particular connection or external ID?
      - Is there a way to search groups by name?
      instructions:
      - text: List all groups.
      - text: List the groups from connection {connection_id}.
        slots:
          connection_id: query.connection_id
      - text: Search groups for {search}.
        slots:
          search: query.search
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a group
      effect: read
      questions:
      - What are the details of a specific group?
      - Can I fetch a group by its ID?
      instructions:
      - text: Get group {id}.
        slots:
          id: path.id
      - text: Show the details of group {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a group
      effect: destructive
      questions:
      - Can I delete a group I no longer need?
      - What's the way to remove a group by ID?
      instructions:
      - text: Delete group {id}.
        slots:
          id: path.id
      - text: Remove the group {id} from my tenant.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups/{id}/members'].get
  update:
    x-apievangelist-phrasing:
      intent: List the users in a group
      effect: read
      questions:
      - Who are the members of a particular group?
      - Can I page through a large group's member list?
      instructions:
      - text: List the members of group {id}.
        slots:
          id: path.id
      - text: Show the next {take} users in group {id}.
        slots:
          take: query.take
          id: path.id
      method: generated
      generated: '2026-10-01'