# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Confluent Cloud Group Mappings (iam/v2/sso) API
  version: 1.0.0
extends: openapi/confluent-group-mappings-iam-v2-sso-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: 5
- target: $.paths['/iam/v2/sso/group-mappings'].get
  update:
    x-apievangelist-phrasing:
      intent: List SSO group mappings
      effect: read
      questions:
      - Which SSO group mappings are configured for my organization?
      - Can I page through all the group mappings?
      instructions:
      - text: List my SSO group mappings.
      - text: List {page_size} group mappings per page.
        slots:
          page_size: query.page_size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v2/sso/group-mappings'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an SSO group mapping
      effect: write
      questions:
      - How do I map an identity provider group to Confluent Cloud permissions?
      - Can I use a CEL condition to match several IdP groups in one mapping?
      instructions:
      - text: Create group mapping {display_name} with filter {filter}.
        slots:
          display_name: requestBody.display_name
          filter: requestBody.filter
      - text: Map the SSO group matched by {filter} into a new group mapping described as {description}.
        slots:
          filter: requestBody.filter
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v2/sso/group-mappings/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read an SSO group mapping
      effect: read
      questions:
      - What filter and principal does a given group mapping use?
      - Can I look up one SSO group mapping by ID?
      instructions:
      - text: Show group mapping {id}.
        slots:
          id: path.id
      - text: Get the filter used by SSO group mapping {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v2/sso/group-mappings/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an SSO group mapping
      effect: destructive
      questions:
      - How do I remove an SSO group mapping?
      - Can I delete a group mapping so that IdP group loses its access?
      instructions:
      - text: Delete group mapping {id}.
        slots:
          id: path.id
      - text: Remove SSO group mapping {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v2/sso/group-mappings/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an SSO group mapping
      effect: write
      questions:
      - Can I change the group filter of an existing mapping?
      - Is it possible to rename or describe a group mapping after creating it?
      instructions:
      - text: Update group mapping {id} to use filter {filter}.
        slots:
          id: path.id
          filter: requestBody.filter
      - text: Rename SSO group mapping {id} to {display_name}.
        slots:
          id: path.id
          display_name: requestBody.display_name
      method: generated
      generated: '2026-09-26'