OneTrust · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Platform - Access Management User Groups API

8 actions 8 updates phrasing extends openapi/onetrust-user-groups-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for OneTrust's API. It is a proposal applied on top of the contract, not a document OneTrust publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 8

$.info
$.paths['/api/access/v1/user-groups'].get
$.paths['/api/access/v1/user-groups'].post
$.paths['/api/access/v1/user-groups/{userGroupId}'].put
$.paths['/api/access/v1/user-groups/{userGroupId}'].delete
$.paths['/api/access/v1/user-groups/{userGroupId}/members'].get
$.paths['/api/access/v1/user-groups/{userGroupId}/members'].post
$.paths['/api/access/v1/user-groups/{userGroupId}/members'].delete

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Platform - Access Management User Groups API
  version: 1.0.0
extends: openapi/onetrust-user-groups-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: 7
- target: $.paths['/api/access/v1/user-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List user groups
      effect: read
      questions:
      - What user groups exist in my account?
      - Can I filter the list of user groups?
      instructions:
      - text: List all user groups.
      - text: Show user groups matching {filters}, sorted by {sort}.
        slots:
          filters: query.filters
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/access/v1/user-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a user group
      effect: write
      questions:
      - How do I set up a new group to manage user access together?
      - Can I give a new user group a description?
      instructions:
      - text: Create a user group called {name}.
        slots:
          name: requestBody.name
      - text: Add user group {name} described as {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/access/v1/user-groups/{userGroupId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or redescribe a user group
      effect: write
      questions:
      - How do I rename an existing user group?
      - Can I change a user group's description?
      instructions:
      - text: Rename user group {userGroupId} to {name}.
        slots:
          userGroupId: path.userGroupId
          name: requestBody.name
      - text: Change the description of user group {userGroupId} to {description}.
        slots:
          userGroupId: path.userGroupId
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/access/v1/user-groups/{userGroupId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a user group
      effect: destructive
      questions:
      - How do I get rid of a user group I no longer use?
      - Can a user group be deleted entirely?
      instructions:
      - text: Delete user group {userGroupId}.
        slots:
          userGroupId: path.userGroupId
      - text: Remove the user group {userGroupId} from the account.
        slots:
          userGroupId: path.userGroupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/access/v1/user-groups/{userGroupId}/members'].get
  update:
    x-apievangelist-phrasing:
      intent: List members of a user group
      effect: read
      questions:
      - Who belongs to a given user group?
      - Can I page through a large group's membership?
      instructions:
      - text: List the members of user group {userGroupId}.
        slots:
          userGroupId: path.userGroupId
      - text: Show page {page} of members in group {userGroupId}.
        slots:
          page: query.page
          userGroupId: path.userGroupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/access/v1/user-groups/{userGroupId}/members'].post
  update:
    x-apievangelist-phrasing:
      intent: Add users to a user group
      effect: write
      questions:
      - How do I add people to a user group?
      - Do users inherit the group's role and organization when added?
      instructions:
      - text: Add users {members} to user group {userGroupId}.
        slots:
          members: requestBody.members
          userGroupId: path.userGroupId
      - text: Make {members} members of group {userGroupId} so they inherit its role.
        slots:
          members: requestBody.members
          userGroupId: path.userGroupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/access/v1/user-groups/{userGroupId}/members'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove users from a user group
      effect: destructive
      questions:
      - How do I take someone out of a user group?
      - Can I remove several members from a group at once?
      instructions:
      - text: Remove users {members} from user group {userGroupId}.
        slots:
          members: requestBody.members
          userGroupId: path.userGroupId
      - text: Drop {members} from the membership of group {userGroupId}.
        slots:
          members: requestBody.members
          userGroupId: path.userGroupId
      method: generated
      generated: '2026-09-26'