OneTrust · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Platform - User Provisioning User Groups V3 API

7 actions 7 updates phrasing extends openapi/onetrust-user-groups-v3-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 7

$.info
$.paths['/api/scim/v3/Groups'].get
$.paths['/api/scim/v3/Groups'].post
$.paths['/api/scim/v3/Groups/{groupId}'].get
$.paths['/api/scim/v3/Groups/{groupId}'].put
$.paths['/api/scim/v3/Groups/{groupId}'].delete
$.paths['/api/scim/v3/Groups/{groupId}'].patch

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 - User Provisioning User Groups V3 API
  version: 1.0.0
extends: openapi/onetrust-user-groups-v3-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: 6
- target: $.paths['/api/scim/v3/Groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List SCIM user groups
      effect: read
      questions:
      - Which user groups can my identity provider see over SCIM?
      - Can I filter SCIM user groups by display name?
      instructions:
      - text: List the SCIM user groups.
      - text: List SCIM groups matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/scim/v3/Groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a SCIM user group
      effect: write
      questions:
      - Can my identity provider create a user group through SCIM?
      - Is it possible to add members while creating a SCIM group?
      instructions:
      - text: Create SCIM group {displayName}.
        slots:
          displayName: requestBody.displayName
      - text: Provision group {displayName} with members {members}.
        slots:
          displayName: requestBody.displayName
          members: requestBody.members
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/scim/v3/Groups/{groupId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a SCIM user group
      effect: read
      questions:
      - Can I look up one SCIM user group and its members?
      - Is it possible to exclude attributes like members when reading a group?
      instructions:
      - text: Get SCIM group {groupId}.
        slots:
          groupId: path.groupId
      - text: Show SCIM group {groupId} without {excludedAttributes}.
        slots:
          groupId: path.groupId
          excludedAttributes: query.excludedAttributes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/scim/v3/Groups/{groupId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a SCIM user group
      effect: write
      questions:
      - Can I fully replace a SCIM group's name and membership in one call?
      - What happens to members not included in a full group update?
      instructions:
      - text: Replace SCIM group {groupId} with name {displayName} and members {members}.
        slots:
          groupId: path.groupId
          displayName: requestBody.displayName
          members: requestBody.members
      - text: Fully overwrite group {groupId}, setting display name {displayName}.
        slots:
          groupId: path.groupId
          displayName: requestBody.displayName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/scim/v3/Groups/{groupId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a SCIM user group
      effect: destructive
      questions:
      - Can my identity provider delete a user group over SCIM?
      - Is a deprovisioned group removed permanently?
      instructions:
      - text: Delete SCIM group {groupId}.
        slots:
          groupId: path.groupId
      - text: Deprovision user group {groupId}.
        slots:
          groupId: path.groupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/scim/v3/Groups/{groupId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch a SCIM user group
      effect: write
      questions:
      - Can I add or remove a few members of a SCIM group without replacing it?
      - Does the SCIM group patch accept add and remove operations?
      instructions:
      - text: Apply patch operations {Operations} to SCIM group {groupId}.
        slots:
          Operations: requestBody.Operations
          groupId: path.groupId
      - text: Patch group {groupId} to add members {members}.
        slots:
          groupId: path.groupId
          members: requestBody.members
      method: generated
      generated: '2026-09-26'