# 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-the-data-streaming-platform-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 groups are mapped to Confluent Cloud roles?
      - Can I see all identity provider group mappings in my org?
      instructions:
      - text: List my SSO group mappings.
      - text: Show every group mapping configured for single sign-on.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v2/sso/group-mappings'].post
  update:
    x-apievangelist-phrasing:
      intent: Map an SSO group
      effect: write
      questions:
      - How do I map an identity provider group so its members get access?
      - Can I create a group mapping with a filter on group claims?
      instructions:
      - text: Create group mapping {display_name} with filter {filter}.
        slots:
          display_name: requestBody.display_name
          filter: requestBody.filter
      - text: Map SSO groups matching {filter} as a new group mapping.
        slots:
          filter: requestBody.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v2/sso/group-mappings/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an SSO group mapping
      effect: read
      questions:
      - What filter does a particular SSO group mapping use?
      - Can I read one group mapping's principal by id?
      instructions:
      - text: Show group mapping {id}.
        slots:
          id: path.id
      - text: Get the filter and principal of 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 stop an identity provider group from getting access?
      - Can I remove an SSO group mapping?
      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 filter on an existing SSO group mapping?
      - Is it possible to rename or redescribe a group mapping?
      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'