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.
# 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 Groups V2 API
version: 1.0.0
extends: openapi/onetrust-groups-v2-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: 4
- target: $.paths['/api/scim/v2/Groups'].get
update:
x-apievangelist-phrasing:
intent: List SCIM role-organization groups
effect: read
questions:
- Why does the SCIM group list show one group per role and organization pair?
- Can I page through the SCIM v2 groups in my account?
instructions:
- text: List the SCIM v2 groups.
- text: List {count} SCIM groups starting at {startIndex}.
slots:
count: query.count
startIndex: query.startIndex
method: generated
generated: '2026-09-26'
- target: $.paths['/api/scim/v2/Groups/{groupId}'].get
update:
x-apievangelist-phrasing:
intent: Get a SCIM v2 group
effect: read
questions:
- Which users sit in a specific SCIM v2 group?
- Can I see when a SCIM group was last modified?
instructions:
- text: Get SCIM v2 group {groupId}.
slots:
groupId: path.groupId
- text: Show users in SCIM group {groupId}, excluding {excludedAttributes}.
slots:
groupId: path.groupId
excludedAttributes: query.excludedAttributes
method: generated
generated: '2026-09-26'
- target: $.paths['/api/scim/v2/Groups/{groupId}'].put
update:
x-apievangelist-phrasing:
intent: Replace a SCIM v2 group's members
effect: write
questions:
- Can I overwrite the full membership of a SCIM v2 group?
- Does the full SCIM group update require a display name?
instructions:
- text: Replace SCIM v2 group {groupId} members with {members}, name {displayName}.
slots:
groupId: path.groupId
members: requestBody.members
displayName: requestBody.displayName
- text: Fully update group {groupId} with display name {displayName}.
slots:
groupId: path.groupId
displayName: requestBody.displayName
method: generated
generated: '2026-09-26'
- target: $.paths['/api/scim/v2/Groups/{groupId}'].patch
update:
x-apievangelist-phrasing:
intent: Patch a SCIM v2 group's members
effect: write
questions:
- Can I add or remove a single user from a SCIM v2 group without a full replace?
- Does the SCIM v2 group patch take add and remove operations?
instructions:
- text: Patch SCIM v2 group {groupId} with operations {Operations}.
slots:
groupId: path.groupId
Operations: requestBody.Operations
- text: Add members {members} to group {groupId} via patch.
slots:
members: requestBody.members
groupId: path.groupId
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.