# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for authentik Enterprise API
  version: 1.0.0
extends: openapi/authentik-enterprise-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 10
- target: $.paths['/enterprise/license/'].get
  update:
    x-apievangelist-phrasing:
      intent: List enterprise licenses
      effect: read
      questions:
      - Which enterprise licenses are installed on my authentik instance?
      - Can I search installed licenses by name?
      instructions:
      - text: List all installed enterprise licenses.
      - text: Find enterprise licenses named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/enterprise/license/'].post
  update:
    x-apievangelist-phrasing:
      intent: Install an enterprise license key
      effect: write
      questions:
      - How do I add a new enterprise license key to authentik?
      - What do I need to activate an enterprise license?
      instructions:
      - text: Install enterprise license key {key}.
        slots:
          key: requestBody.key
      - text: Add a new license using the key {key}.
        slots:
          key: requestBody.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/enterprise/license/{license_uuid}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one enterprise license
      effect: read
      questions:
      - What are the details of one specific installed license?
      - How do I look up a single enterprise license by its UUID?
      instructions:
      - text: Show enterprise license {license_uuid}.
        slots:
          license_uuid: path.license_uuid
      - text: Get the details of installed license {license_uuid}.
        slots:
          license_uuid: path.license_uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/enterprise/license/{license_uuid}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace the key of an installed license
      effect: write
      questions:
      - How do I swap the key on an existing license record with a renewed one?
      - Can I replace an installed license's key in full?
      instructions:
      - text: Replace the key of license {license_uuid} with {key}.
        slots:
          license_uuid: path.license_uuid
          key: requestBody.key
      - text: Overwrite installed license {license_uuid} with renewed key {key}.
        slots:
          license_uuid: path.license_uuid
          key: requestBody.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/enterprise/license/{license_uuid}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an enterprise license
      effect: destructive
      questions:
      - How do I uninstall an enterprise license I no longer use?
      - Can I delete an expired license from authentik?
      instructions:
      - text: Delete enterprise license {license_uuid}.
        slots:
          license_uuid: path.license_uuid
      - text: Uninstall the license {license_uuid}.
        slots:
          license_uuid: path.license_uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/enterprise/license/{license_uuid}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch an installed license's key
      effect: write
      questions:
      - Can I patch just the key field on an installed license?
      - Is there a partial-update call for an existing enterprise license?
      instructions:
      - text: Patch license {license_uuid} so its key becomes {key}.
        slots:
          license_uuid: path.license_uuid
          key: requestBody.key
      - text: Partially update enterprise license {license_uuid} with key {key}.
        slots:
          license_uuid: path.license_uuid
          key: requestBody.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/enterprise/license/{license_uuid}/used_by/'].get
  update:
    x-apievangelist-phrasing:
      intent: See what depends on a license
      effect: read
      questions:
      - What objects reference a given enterprise license?
      - Would removing this license affect anything that uses it?
      instructions:
      - text: List everything that uses license {license_uuid}.
        slots:
          license_uuid: path.license_uuid
      - text: Show the objects depending on enterprise license {license_uuid}.
        slots:
          license_uuid: path.license_uuid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/enterprise/license/forecast/'].get
  update:
    x-apievangelist-phrasing:
      intent: Forecast license user needs for a year
      effect: read
      questions:
      - How many users will I need to license a year from now?
      - Can authentik project my user growth for license planning?
      instructions:
      - text: Forecast how many licensed users I will need next year.
      - text: Show the one-year user forecast for enterprise licensing.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/enterprise/license/install_id/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the installation ID
      effect: read
      questions:
      - Where do I find my authentik install ID to request a license?
      - What is the unique installation identifier for this deployment?
      instructions:
      - text: Get this installation's install ID.
      - text: Show the install_id I need for license requests.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/enterprise/license/summary/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the overall license status
      effect: read
      questions:
      - Is my enterprise license currently valid across the whole instance?
      - Can I get the total license status without using the cached value?
      instructions:
      - text: Show the total enterprise license status.
      - text: Get the license summary with cached set to {cached}.
        slots:
          cached: query.cached
      method: generated
      generated: '2026-09-26'