# 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 Clients API
  version: 1.0.0
extends: openapi/auth0-clients-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: 14
- target: $.paths['/clients'].get
  update:
    x-apievangelist-phrasing:
      intent: List applications in a tenant
      effect: read
      questions:
      - Which applications are registered in my tenant?
      - Can I filter the application list to only first-party or a certain app type?
      - What's the way to find an application by its external client ID?
      instructions:
      - text: List my applications.
      - text: List applications of type {app_type}.
        slots:
          app_type: query.app_type
      - text: Find applications matching {q}.
        slots:
          q: query.q
      method: generated
      generated: '2026-10-01'
- target: $.paths['/clients'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an application
      effect: write
      questions:
      - How do I register a new application for login?
      - Can I set callback URLs and the app type when creating an application?
      instructions:
      - text: Create an application named {name}.
        slots:
          name: requestBody.name
      - text: Create a {app_type} application {name} with callback {callbacks}.
        slots:
          app_type: requestBody.app_type
          name: requestBody.name
          callbacks: requestBody.callbacks
      method: generated
      generated: '2026-10-01'
- target: $.paths['/clients/cimd/preview'].post
  update:
    x-apievangelist-phrasing:
      intent: Preview a Client ID Metadata Document
      effect: read
      questions:
      - Can I validate a Client ID Metadata Document before registering it?
      - What would a CIMD URL map to as client fields, without creating anything?
      instructions:
      - text: Preview the client metadata document at {external_client_id}.
        slots:
          external_client_id: requestBody.external_client_id
      - text: Validate CIMD {external_client_id} without creating a client.
        slots:
          external_client_id: requestBody.external_client_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/clients/cimd/register'].post
  update:
    x-apievangelist-phrasing:
      intent: Register or update a CIMD client
      effect: write
      questions:
      - How do I register a client from its Client ID Metadata Document URL?
      - Does registering a CIMD client again update the existing one?
      instructions:
      - text: Register the CIMD client {external_client_id}.
        slots:
          external_client_id: requestBody.external_client_id
      - text: Upsert a client from metadata URI {external_client_id}.
        slots:
          external_client_id: requestBody.external_client_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/clients/{client_id}/credentials'].get
  update:
    x-apievangelist-phrasing:
      intent: List an application's credentials
      effect: read
      questions:
      - Which credentials, like public keys or certificates, does an application have?
      - Can I list the private key JWT credentials on an app?
      instructions:
      - text: List credentials for application {client_id}.
        slots:
          client_id: path.client_id
      - text: Show the public keys registered on client {client_id}.
        slots:
          client_id: path.client_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/clients/{client_id}/credentials'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a credential to an application
      effect: write
      questions:
      - How do I upload a public key for Private Key JWT authentication?
      - Can I add an mTLS certificate credential to an application?
      instructions:
      - text: Add a {credential_type} credential to application {client_id} with PEM {pem}.
        slots:
          credential_type: requestBody.credential_type
          client_id: path.client_id
          pem: requestBody.pem
      - text: Create credential {name} of type {credential_type} on client {client_id}.
        slots:
          name: requestBody.name
          credential_type: requestBody.credential_type
          client_id: path.client_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/clients/{client_id}/credentials/{credential_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one application credential
      effect: read
      questions:
      - Can I inspect one specific credential on an application?
      - When does a particular client credential expire?
      instructions:
      - text: Show credential {credential_id} of application {client_id}.
        slots:
          credential_id: path.credential_id
          client_id: path.client_id
      - text: Get the expiry of credential {credential_id} on client {client_id}.
        slots:
          credential_id: path.credential_id
          client_id: path.client_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/clients/{client_id}/credentials/{credential_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an application credential
      effect: destructive
      questions:
      - How do I remove an old public key from an application?
      - Can I delete a client credential I created earlier?
      instructions:
      - text: Delete credential {credential_id} from application {client_id}.
        slots:
          credential_id: path.credential_id
          client_id: path.client_id
      - text: Remove key {credential_id} on client {client_id}.
        slots:
          credential_id: path.credential_id
          client_id: path.client_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/clients/{client_id}/credentials/{credential_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a credential's expiry
      effect: write
      questions:
      - Can I change the expiration date of an existing client credential?
      - Is the expiry the only thing I can update on a credential?
      instructions:
      - text: Set credential {credential_id} on client {client_id} to expire at {expires_at}.
        slots:
          credential_id: path.credential_id
          client_id: path.client_id
          expires_at: requestBody.expires_at
      - text: Extend the expiry of key {credential_id} for application {client_id} to {expires_at}.
        slots:
          credential_id: path.credential_id
          client_id: path.client_id
          expires_at: requestBody.expires_at
      method: generated
      generated: '2026-10-01'
- target: $.paths['/clients/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an application by ID
      effect: read
      questions:
      - Can I see the full settings of one application?
      - What callback URLs are configured on a given app?
      instructions:
      - text: Show application {id}.
        slots:
          id: path.id
      - text: Get only the {fields} fields of client {id}.
        slots:
          fields: query.fields
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/clients/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an application
      effect: destructive
      questions:
      - How do I delete an application and its related configuration?
      - Can I remove an app I no longer use from the tenant?
      instructions:
      - text: Delete application {id}.
        slots:
          id: path.id
      - text: Remove client {id} from my tenant.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/clients/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an application's settings
      effect: write
      questions:
      - How do I add a new callback URL to an existing application?
      - Can I change an application's allowed logout URLs or grant types?
      - Is it possible to set a client secret myself on an app?
      instructions:
      - text: Set callbacks on application {id} to {callbacks}.
        slots:
          id: path.id
          callbacks: requestBody.callbacks
      - text: Rename application {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Update allowed logout URLs of client {id} to {allowed_logout_urls}.
        slots:
          id: path.id
          allowed_logout_urls: requestBody.allowed_logout_urls
      method: generated
      generated: '2026-10-01'
- target: $.paths['/clients/{id}/connections'].get
  update:
    x-apievangelist-phrasing:
      intent: List connections enabled for an application
      effect: read
      questions:
      - Which login connections are turned on for a given application?
      - Can I list only the social connections enabled for one app?
      instructions:
      - text: List connections enabled for application {id}.
        slots:
          id: path.id
      - text: Show {strategy} connections enabled on client {id}.
        slots:
          strategy: query.strategy
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/clients/{id}/rotate-secret'].post
  update:
    x-apievangelist-phrasing:
      intent: Rotate an application's client secret
      effect: destructive
      questions:
      - How do I rotate a client secret that may have leaked?
      - Does rotating the secret break apps using the old one?
      instructions:
      - text: Rotate the client secret of application {id}.
        slots:
          id: path.id
      - text: Generate a new secret for client {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'