# 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 Organizations API
  version: 1.0.0
extends: openapi/onetrust-organizations-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/access/v1/external/organizations'].get
  update:
    x-apievangelist-phrasing:
      intent: List organizations in the hierarchy
      effect: read
      questions:
      - What organizations make up our OneTrust org hierarchy?
      - How is our organization tree structured?
      instructions:
      - text: List all organizations in the hierarchy.
      - text: Show the organization tree.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/access/v1/external/organizations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an organization
      effect: write
      questions:
      - How do I add a new business unit to the org hierarchy?
      - Where does a new organization go if I don't give a parent?
      instructions:
      - text: Create organization {name} with external ID {externalId} and default approver {defaultApprover}.
        slots:
          name: requestBody.name
          externalId: requestBody.externalId
          defaultApprover: requestBody.defaultApprover
      - text: Add org {name} ({externalId}) under parent {parentExternalId}, approver {defaultApprover}.
        slots:
          name: requestBody.name
          externalId: requestBody.externalId
          parentExternalId: requestBody.parentExternalId
          defaultApprover: requestBody.defaultApprover
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/access/v1/external/organizations/{externalId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an organization
      effect: write
      questions:
      - How do I rename an organization or change its default approver?
      - Can I move an existing organization under a different parent?
      instructions:
      - text: Update organization {externalId} with name {name} and approver {defaultApprover}.
        slots:
          externalId: path.externalId
          name: requestBody.name
          defaultApprover: requestBody.defaultApprover
      - text: Change the default language of organization {externalId} to {defaultLanguageCode}.
        slots:
          externalId: path.externalId
          defaultLanguageCode: requestBody.defaultLanguageCode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/access/v1/external/organizations/{externalId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an organization
      effect: destructive
      questions:
      - How do I delete an organization and keep its records?
      - Where do an organization's objects go when it is deleted?
      instructions:
      - text: Delete organization {externalId} and move its objects to {targetExternalId}.
        slots:
          externalId: path.externalId
          targetExternalId: query.targetExternalId
      - text: Remove org {externalId}, reassigning everything to {targetExternalId}.
        slots:
          externalId: path.externalId
          targetExternalId: query.targetExternalId
      method: generated
      generated: '2026-09-26'