# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for LXD external REST Identity Provider Groups API
  version: 1.0.0
extends: openapi/canonical-identity-provider-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: 8
- target: $.paths['/1.0/auth/identity-provider-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List identity provider groups as URLs
      effect: read
      questions:
      - Which identity provider groups are mapped in LXD?
      - Can I get just the URLs of my IdP group mappings?
      instructions:
      - text: List the URLs of all identity provider groups.
      - text: Show identity provider group links configured in LXD.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/1.0/auth/identity-provider-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an identity provider group mapping
      effect: write
      questions:
      - How do I map a group from my identity provider onto LXD groups?
      - Can one IdP group be mapped to several LXD authorization groups?
      instructions:
      - text: Create identity provider group {name}.
        slots:
          name: requestBody.name
      - text: Map IdP group {name} to LXD groups {groups}.
        slots:
          name: requestBody.name
          groups: requestBody.groups
      method: generated
      generated: '2026-09-26'
- target: $.paths['/1.0/auth/identity-provider-groups/{idpGroupName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an identity provider group
      effect: read
      questions:
      - Which LXD groups is a particular IdP group mapped to?
      - What does one identity provider group mapping contain?
      instructions:
      - text: Show identity provider group {idpGroupName} and its mapped groups.
        slots:
          idpGroupName: path.idpGroupName
      - text: Get the mapping for this IdP group.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/1.0/auth/identity-provider-groups/{idpGroupName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an IdP group's mapped groups
      effect: write
      questions:
      - How do I overwrite the full list of LXD groups an IdP group maps to?
      - Will replacing the mapping remove groups I leave out?
      instructions:
      - text: Replace the mapped groups of IdP group {idpGroupName} with {groups}.
        slots:
          idpGroupName: path.idpGroupName
          groups: requestBody.groups
      - text: Set the full group mapping of the identity provider group to exactly {groups}.
        slots:
          groups: requestBody.groups
      method: generated
      generated: '2026-10-01'
- target: $.paths['/1.0/auth/identity-provider-groups/{idpGroupName}'].post
  update:
    x-apievangelist-phrasing:
      intent: Rename an identity provider group
      effect: write
      questions:
      - Can I rename an identity provider group mapping in LXD?
      - What happens to the mapping when an IdP group gets a new name?
      instructions:
      - text: Rename identity provider group {idpGroupName} to {name}.
        slots:
          idpGroupName: path.idpGroupName
          name: requestBody.name
      - text: Give this IdP group mapping the new name {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/1.0/auth/identity-provider-groups/{idpGroupName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an identity provider group
      effect: destructive
      questions:
      - How do I remove an IdP group mapping from LXD?
      - Does deleting an identity provider group delete the LXD groups it maps to?
      instructions:
      - text: Delete identity provider group {idpGroupName}.
        slots:
          idpGroupName: path.idpGroupName
      - text: Remove the IdP group mapping from LXD.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/1.0/auth/identity-provider-groups/{idpGroupName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Add groups to an IdP group mapping
      effect: write
      questions:
      - Can I add one more LXD group to an existing IdP mapping without replacing it?
      - How do I partially update an identity provider group?
      instructions:
      - text: Patch IdP group mapping {idpGroupName} to include groups {groups}.
        slots:
          idpGroupName: path.idpGroupName
          groups: requestBody.groups
      - text: Partially update the identity provider group with {groups}.
        slots:
          groups: requestBody.groups
      method: generated
      generated: '2026-10-01'
- target: $.paths['/1.0/auth/identity-provider-groups?recursion=1'].get
  update:
    x-apievangelist-phrasing:
      intent: List identity provider groups with mappings
      effect: read
      questions:
      - How do I see every IdP group together with the LXD groups it maps to?
      - Can I get full identity provider group objects in one call?
      instructions:
      - text: List all identity provider groups with their group mappings.
      - text: Get expanded IdP group records.
      method: generated
      generated: '2026-09-26'