OneTrust · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Platform - Access Management Audit Records API

3 actions 3 updates phrasing extends openapi/onetrust-audit-records-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 3

$.info

$.paths['/api/access/v1/login-history'].get

$.paths['/api/audit/v1/users/{userId}/activities'].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 Platform - Access Management Audit Records API
  version: 1.0.0
extends: openapi/onetrust-audit-records-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: 2
- target: $.paths['/api/access/v1/login-history'].get
  update:
    x-apievangelist-phrasing:
      intent: Get login history for audit
      effect: read
      questions:
      - Who logged in to the account over the last month?
      - Can I pull the sign-in history for one user between two dates?
      instructions:
      - text: Show the login history of user {userId}.
        slots:
          userId: query.userId
      - text: List all user logins between {startDate} and {endDate}.
        slots:
          startDate: query.startDate
          endDate: query.endDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/audit/v1/users/{userId}/activities'].get
  update:
    x-apievangelist-phrasing:
      intent: Audit changes made to a user's profile
      effect: read
      questions:
      - What changes were made to a user's roles and organizations over time?
      - Can I see the audit trail of edits to one user's profile?
      instructions:
      - text: Show the profile change history of user {userId}.
        slots:
          userId: path.userId
      - text: List role and organization changes made to user {userId}, including child objects.
        slots:
          userId: path.userId
      method: generated
      generated: '2026-09-26'