# 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 Client Grants API
  version: 1.0.0
extends: openapi/auth0-client-grants-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: 6
- target: $.paths['/client-grants'].get
  update:
    x-apievangelist-phrasing:
      intent: List client grants between apps and APIs
      effect: read
      questions:
      - Which machine-to-machine applications have been granted access to my API?
      - What scopes has a particular application been granted across APIs?
      - Can I filter client grants to the ones that allow any organization?
      instructions:
      - text: List all client grants.
      - text: List client grants for API audience {audience}.
        slots:
          audience: query.audience
      - text: Show the client grants held by application {client_id}.
        slots:
          client_id: query.client_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/client-grants'].post
  update:
    x-apievangelist-phrasing:
      intent: Grant an application access to an API
      effect: write
      questions:
      - How do I authorize a machine-to-machine app to call my API with the client credentials flow?
      - Can I grant every scope of an API to an application at once?
      instructions:
      - text: Grant application {client_id} access to API {audience} with scopes {scope}.
        slots:
          client_id: requestBody.client_id
          audience: requestBody.audience
          scope: requestBody.scope
      - text: Create a client grant for audience {audience} with organization usage {organization_usage}.
        slots:
          audience: requestBody.audience
          organization_usage: requestBody.organization_usage
      method: generated
      generated: '2026-10-01'
- target: $.paths['/client-grants/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one client grant
      effect: read
      questions:
      - Which scopes does a specific client grant include?
      - Can I look up a single application-to-API grant by its ID?
      instructions:
      - text: Show me client grant {id}.
        slots:
          id: path.id
      - text: List the scopes on client grant {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/client-grants/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an application's access to an API
      effect: destructive
      questions:
      - How do I stop a machine-to-machine app from getting tokens for my API?
      - What happens when I delete a client grant?
      instructions:
      - text: Delete client grant {id}.
        slots:
          id: path.id
      - text: Revoke the client credentials access granted by {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/client-grants/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change the scopes or org usage of a client grant
      effect: write
      questions:
      - Can I add or remove scopes on an existing client grant?
      - How do I require organizations on a grant that already exists?
      instructions:
      - text: Set the scopes on client grant {id} to {scope}.
        slots:
          id: path.id
          scope: requestBody.scope
      - text: Change organization usage on existing grant {id} to {organization_usage}.
        slots:
          id: path.id
          organization_usage: requestBody.organization_usage
      method: generated
      generated: '2026-10-01'
- target: $.paths['/client-grants/{id}/organizations'].get
  update:
    x-apievangelist-phrasing:
      intent: List organizations tied to a client grant
      effect: read
      questions:
      - Which organizations are associated with a given client grant?
      - Can I page through the organizations linked to an app's API grant?
      instructions:
      - text: List the organizations associated with client grant {id}.
        slots:
          id: path.id
      - text: Show page {page} of organizations on grant {id}.
        slots:
          page: query.page
          id: path.id
      method: generated
      generated: '2026-10-01'