# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for User and Access Management Groups API
  version: 1.0.0
extends: openapi/outsystems-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: 10
- target: $.paths['/groups/{key}/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List members of a group
      effect: read
      questions:
      - Who belongs to a given end-user group?
      - Can I tell direct group members apart from other membership types?
      instructions:
      - text: List the users in group {key}.
        slots:
          key: path.key
      - text: Find members of group {key} whose name or email contains {nameOrEmailContains}.
        slots:
          key: path.key
          nameOrEmailContains: query.nameOrEmailContains
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups/{key}/users'].patch
  update:
    x-apievangelist-phrasing:
      intent: Add or remove group members
      effect: write
      questions:
      - How do I add several users to a group in one request?
      - Can I remove people from a group and add others at the same time?
      instructions:
      - text: Add users {userKeysToAdd} to group {key}.
        slots:
          userKeysToAdd: requestBody.userKeysToAdd
          key: path.key
      - text: Remove users {userKeysToRemove} from group {key}.
        slots:
          userKeysToRemove: requestBody.userKeysToRemove
          key: path.key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List end-user groups
      effect: read
      questions:
      - What end-user groups exist in my ODC organization?
      - Can I filter groups by stage or by identity provider?
      instructions:
      - text: List all groups in stage {environmentKey}.
        slots:
          environmentKey: query.environmentKey
      - text: Find groups whose name contains {nameContains}.
        slots:
          nameContains: query.nameContains
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an end-user group
      effect: write
      questions:
      - How do I create a new group of end users in a stage?
      - Can I assign users and application roles when I create a group?
      instructions:
      - text: Create group {name} in stage {environmentKey}.
        slots:
          name: requestBody.name
          environmentKey: requestBody.environmentKey
      - text: Create group {name} in {environmentKey} with users {userKeys}.
        slots:
          name: requestBody.name
          environmentKey: requestBody.environmentKey
          userKeys: requestBody.userKeys
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups/{key}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a group's details
      effect: read
      questions:
      - What's the name, description and stage of a particular group?
      - How do I look up a single group by its key?
      instructions:
      - text: Get group {key}.
        slots:
          key: path.key
      - text: Show the details of group {key}.
        slots:
          key: path.key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups/{key}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a group
      effect: destructive
      questions:
      - Can I delete an end-user group I no longer need?
      - What permission is required to remove a group?
      instructions:
      - text: Delete group {key}.
        slots:
          key: path.key
      - text: Remove the group {key} permanently.
        slots:
          key: path.key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups/{key}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or redescribe a group
      effect: write
      questions:
      - How do I rename an existing group?
      - Can I edit a group's description after creating it?
      instructions:
      - text: Rename group {key} to {name}.
        slots:
          key: path.key
          name: requestBody.name
      - text: Set the description of group {key} to {description}.
        slots:
          key: path.key
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups/{key}/application-roles'].get
  update:
    x-apievangelist-phrasing:
      intent: List a group's application roles
      effect: read
      questions:
      - Which application roles does a group grant its members?
      - Can I see a group's app roles for just one app?
      instructions:
      - text: List the application roles assigned to group {key}.
        slots:
          key: path.key
      - text: Show group {key}'s roles for app {assetKey}.
        slots:
          key: path.key
          assetKey: query.assetKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups/{key}/application-roles'].patch
  update:
    x-apievangelist-phrasing:
      intent: Add or remove a group's application roles
      effect: write
      questions:
      - How do I give a whole group a new application role?
      - Can I take application roles away from a group?
      instructions:
      - text: Add application roles {applicationRoleKeysToAdd} to group {key}.
        slots:
          applicationRoleKeysToAdd: requestBody.applicationRoleKeysToAdd
          key: path.key
      - text: Remove application roles {applicationRoleKeysToRemove} from group {key}.
        slots:
          applicationRoleKeysToRemove: requestBody.applicationRoleKeysToRemove
          key: path.key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups/{key}/claim-mappings/{mappingKey}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a group's identity provider claim mapping
      effect: destructive
      questions:
      - How do I remove an IdP claim mapping that auto-assigns users to a group?
      - Can I delete one identity provider mapping from a group?
      instructions:
      - text: Delete claim mapping {mappingKey} from group {key}.
        slots:
          mappingKey: path.mappingKey
          key: path.key
      - text: Remove the IdP claim mapping {mappingKey} on group {key}.
        slots:
          mappingKey: path.mappingKey
          key: path.key
      method: generated
      generated: '2026-10-01'