OneTrust · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Consent & Preferences - Universal Consent & Preference…

6 actions 6 updates phrasing extends openapi/onetrust-data-subject-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 6

$.info

$.paths['/api/consentmanager/v2/linkedidentitygroups'].get

$.paths['/api/consentmanager/v2/linkedidentitygroups'].post

$.paths['/api/consentmanager/v2/linkedidentitygroups/{linkedIdentityGroupId}'].get

$.paths['/api/consentmanager/v2/linkedidentitygroups/{linkedIdentityGroupId}'].put

$.paths['/api/consentmanager/v2/linkedidentitygroups/{linkedIdentityGroupId}'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Consent & Preferences - Universal Consent & Preference…
  version: 1.0.0
extends: openapi/onetrust-data-subject-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: 5
- target: $.paths['/api/consentmanager/v2/linkedidentitygroups'].get
  update:
    x-apievangelist-phrasing:
      intent: List data subject groups
      effect: read
      questions:
      - Which Data Subject Groups exist, and how many people are in each?
      - Can I find the group a primary data subject belongs to?
      instructions:
      - text: List all Data Subject Groups.
      - text: List Data Subject Groups for primary identifier {primaryDataSubjectIdentifier}.
        slots:
          primaryDataSubjectIdentifier: header.primaryDataSubjectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/consentmanager/v2/linkedidentitygroups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a data subject group
      effect: write
      questions:
      - Can I link several identifiers of the same person into one group?
      - How many data subjects does a Data Subject Group need?
      instructions:
      - text: Create Data Subject Group {groupName} with primary {primaryIdentifier} and identifiers {identifiers}.
        slots:
          groupName: requestBody.groupName
          primaryIdentifier: requestBody.primaryIdentifier
          identifiers: requestBody.identifiers
      - text: Link identifiers {identifiers} into a new group.
        slots:
          identifiers: requestBody.identifiers
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/consentmanager/v2/linkedidentitygroups/{linkedIdentityGroupId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a data subject group
      effect: read
      questions:
      - Which data subjects are inside one Data Subject Group?
      - Can I show the organizations for a group's members?
      instructions:
      - text: Get Data Subject Group {linkedIdentityGroupId}.
        slots:
          linkedIdentityGroupId: path.linkedIdentityGroupId
      - text: Show the members of group {linkedIdentityGroupId}.
        slots:
          linkedIdentityGroupId: path.linkedIdentityGroupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/consentmanager/v2/linkedidentitygroups/{linkedIdentityGroupId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a data subject group
      effect: write
      questions:
      - Can I change the primary identifier of a Data Subject Group?
      - Is it possible to rename a Data Subject Group or change its members?
      instructions:
      - text: Update group {linkedIdentityGroupId} with identifiers {identifiers}.
        slots:
          linkedIdentityGroupId: path.linkedIdentityGroupId
          identifiers: requestBody.identifiers
      - text: Rename Data Subject Group {linkedIdentityGroupId} to {groupName}.
        slots:
          linkedIdentityGroupId: path.linkedIdentityGroupId
          groupName: requestBody.groupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/consentmanager/v2/linkedidentitygroups/{linkedIdentityGroupId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a data subject group
      effect: destructive
      questions:
      - Can I break up a Data Subject Group I no longer need?
      - Is deleting a Data Subject Group permanent?
      instructions:
      - text: Delete Data Subject Group {linkedIdentityGroupId}.
        slots:
          linkedIdentityGroupId: path.linkedIdentityGroupId
      - text: Remove linked identity group {linkedIdentityGroupId}.
        slots:
          linkedIdentityGroupId: path.linkedIdentityGroupId
      method: generated
      generated: '2026-09-26'