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-v4-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['/rest/api/consent/v4/groups'].get

$.paths['/rest/api/consent/v4/linkedidentitygroups'].get

$.paths['/rest/api/consent/v4/linkedidentitygroups'].post

$.paths['/rest/api/consent/v4/linkedidentitygroups/{dataSubjectGroupId}'].put

$.paths['/rest/api/consent/v4/linkedidentitygroups/{dataSubjectGroupId}/members'].get

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-v4-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['/rest/api/consent/v4/groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List Data Subject Groups
      effect: read
      questions:
      - What Data Subject Groups exist for linking identities like a household?
      - Can I look up Data Subject Groups by group name?
      instructions:
      - text: List all Data Subject Groups.
      - text: Find Data Subject Groups named {groupName}.
        slots:
          groupName: header.groupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/consent/v4/linkedidentitygroups'].get
  update:
    x-apievangelist-phrasing:
      intent: List the groups a data subject belongs to
      effect: read
      questions:
      - Which Data Subject Groups is a particular person part of?
      - Can I check a data subject's membership in one specific group?
      instructions:
      - text: Show which Data Subject Groups {identifier} belongs to.
        slots:
          identifier: header.identifier
      - text: Get the association between {identifier} and group {linkedIdentityGroupId}.
        slots:
          identifier: header.identifier
          linkedIdentityGroupId: query.linkedIdentityGroupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/consent/v4/linkedidentitygroups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Data Subject Group
      effect: write
      questions:
      - How do I group several data subjects so consent can be shared between them?
      - How many members does a Data Subject Group need at minimum?
      instructions:
      - text: Create Data Subject Group {groupName} with members {memberIdentifiers} and primary {primaryIdentifiers}.
        slots:
          groupName: requestBody.groupName
          memberIdentifiers: requestBody.memberIdentifiers
          primaryIdentifiers: requestBody.primaryIdentifiers
      - text: Group identities {memberIdentifiers} as {groupName}, with {primaryIdentifiers} as primary.
        slots:
          memberIdentifiers: requestBody.memberIdentifiers
          groupName: requestBody.groupName
          primaryIdentifiers: requestBody.primaryIdentifiers
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/consent/v4/linkedidentitygroups/{dataSubjectGroupId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a Data Subject Group's members
      effect: write
      questions:
      - How do I add or remove people from an existing Data Subject Group?
      - Can I change which member is primary in a Data Subject Group?
      instructions:
      - text: Update Data Subject Group {dataSubjectGroupId} to name {groupName}, members {memberIdentifiers}, primary {primaryIdentifiers}.
        slots:
          dataSubjectGroupId: path.dataSubjectGroupId
          groupName: requestBody.groupName
          memberIdentifiers: requestBody.memberIdentifiers
          primaryIdentifiers: requestBody.primaryIdentifiers
      - text: Make {primaryIdentifiers} the primary of group {dataSubjectGroupId} ({groupName}) with members {memberIdentifiers}.
        slots:
          primaryIdentifiers: requestBody.primaryIdentifiers
          dataSubjectGroupId: path.dataSubjectGroupId
          groupName: requestBody.groupName
          memberIdentifiers: requestBody.memberIdentifiers
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/consent/v4/linkedidentitygroups/{dataSubjectGroupId}/members'].get
  update:
    x-apievangelist-phrasing:
      intent: List members of a Data Subject Group
      effect: read
      questions:
      - Who are the members of a given Data Subject Group?
      - Can I page through the members of a large group?
      instructions:
      - text: List the members of Data Subject Group {dataSubjectGroupId}.
        slots:
          dataSubjectGroupId: path.dataSubjectGroupId
      - text: Show page {page} of members in group {dataSubjectGroupId}.
        slots:
          page: query.page
          dataSubjectGroupId: path.dataSubjectGroupId
      method: generated
      generated: '2026-09-26'