We've detected that you are using the Brave browser. This site does not display correctly when the Brave Shields are enabled. Please set your Shields to Down.

OneTrust Internal Users: DO NOT MAKE ANY DIRECT CHANGES!

All documentation updates should be made by submitting a DOC ticket, and changes to the APIs should be made by opening a merge request (MR) in the SARCH (sandbox) or DX (production) GitLab Repos.

Jump to Content
OneTrust Developer PortalmyOneTrustDeveloper ForumTechnology Partners
SDK ReferenceRecipesAPI ReferenceChangelog
myOneTrustDeveloper ForumTechnology PartnersLog InOneTrust Developer Portal
API Reference
Log In
SDK ReferenceRecipesAPI ReferenceChangelog

GETTING STARTED

  • OneTrust API Reference
    • The Trust Intelligence Platform
    • Privacy & Data Governance Cloud
    • GRC & Security Assurance Cloud
    • ESG & Sustainability Cloud
  • Quick Start Guide: APIs
  • OAuth 2.0
    • OAuth 2.0 Scopes
    • Managing OAuth 2.0 API Keys
    • Managing OAuth 2.0 Client Credentials

api resources

  • API Rate Limits
  • API Guides
    • Cookie Consent
      • Creating a New Cookie Runner Script
      • Bulk Domain Management
    • Data Discovery
      • Custom Scan using Worker Node APIs
    • Integrations
      • Integrating with Webhooks
    • IT & Security Risk Management
      • Updating a Control Implementation
      • Updating Risk Details
    • PIA & DPIA Automation
      • Importing GDPR Transfer Impact Assessment Template into the OneTrust Application
    • Policy & Notice Management
      • Managing Policies and Notices
    • SCIM User Provisioning
      • Updating a User's Role & Organization
      • Managing Users
      • Managing Organizations
    • The Trust Intelligence Platform
      • Bulk Export Demo Videos
    • Universal Consent & Preference Management
      • API Use Cases & Best Practices
      • API Service Level Objectives
      • Using the Preference Center Schema to Build Multi Page Preference Centers
      • Using the Preference Center Schema to Build Original or Enhanced Preference Centers
      • Using Consent Groups to Alter a Data Subject's Consent Status
      • Enabling iFraming of a OneTrust Preference Center
      • Migrating to Data Subjects v4 Endpoints
  • Supported Languages and HTML Language Codes
  • OneTrust API Sunsetting & Deprecation Guidelines
    • Deprecated APIs List
  • Understanding & Implementing Pagination

The Trust Intelligence Platform - Access Management

  • Audit Records
    • Get Audit Records for Login Historyget
    • Get Audit Records for User's Profileget
  • Organizations
    • Get List of Organizationsget
    • Create Organizationpost
    • Delete Organizationdelete
    • Update Organizationput
  • User Groups
    • Get List of User Groupsget
    • Create User Grouppost
    • Delete User Groupdelete
    • Update User Groupput
    • Remove Members from User Groupdelete
    • Get User Group Membersget
    • Add Members to User Grouppost

The Trust Intelligence Platform - Authorization

  • OAuth Token
    • Generate Access Tokenpost

The Trust Intelligence Platform - Bulk Export

  • Bulk Export
    • Get List of Bulk Exportsget
    • Create Bulk Exportpost
    • Get Bulk Export Credit Detailsget
    • Get Bulk Export Statusget
    • Cancel Bulk Exportdelete
    • Get Bulk Export Download Detailsget

The Trust Intelligence Platform - Documents

  • Attachments
    • Get File Locationget
    • Upload Filepost

The Trust Intelligence Platform - Integration Manager

  • System Credentials
    • Create System Credentialpost
    • Update System Credentialput
  • Workflows V2
    • Export Workflowget
    • Import Workflowpost

The Trust Intelligence Platform - Inventory

  • Relationship Management
    • Create Relationshippost
    • Delete Relationshipdelete
    • Get Relationshipget

The Trust Intelligence Platform - Object Manager

  • Object Attribute Management
    • Add Options to Attributepost
    • Add Attribute to Schemapost
    • Disable Attributeput
    • Enable Attributeput
  • Object Relationship Type Management
    • Create Relationship Type between Objectspost
    • Get List of Relationship Link Typespost
    • Get Relationship Typeget
  • Object Relationship Management
    • Create Relationship Record between Objectspost
    • Remove Relationship Recorddelete
    • Get Relationship Recordget
  • Object Management
    • Create Objectpost
    • Get Full Object Detailspost
    • Delete Objectdelete
    • Get Objectget
    • Modify Objectpatch
    • Get Basic Object Detailspost
  • Object Task Management
    • Create Taskpost
    • Get Taskget
    • Update Taskput
  • Object Type Management
    • Get List of Object Typespost
    • Get Object Typeget
    • Modify Custom Object Typepatch
    • Enable Custom Object Typeput

The Trust Intelligence Platform - User Provisioning V3

  • User Groups
    • Get List of User Groupsget
    • Create User Grouppost
    • Delete User Groupdelete
    • Get User Groupget
    • Modify User Grouppatch
    • Update User Groupput
  • Users
    • Get List of Usersget
    • Create Userpost
    • Get Userget
    • Modify Userpatch
    • Update Userput

The Trust Intelligence Platform - User Provisioning V2

  • Groups
    • Get List of Groupsget
    • Get Groupget
    • Modify Grouppatch
    • Update Groupput
  • Resources
    • Get Supported Resourcesget
    • Get Supported Resource Typesget
  • SCIM Schemas
    • Get List of Supported SCIM Schemasget
    • Get SCIM Schemaget
  • Service Provider
    • Get Service Provider Configurationget
  • Users
    • Get List of Usersget
    • Add Userpost
    • Delete Userdelete
    • Get Userget
    • Modify Userpatch
    • Update Userput

Privacy Cloud - Consent & Preference Management

  • Collection Points
    • Get List of Collection Pointsget
    • Create Collection Pointpost
    • Get Collection Point Tokenget
    • Update Existing Collection Pointput
    • Update Collection Point Statusput
  • Collection Points V2
    • Get List of Collection Pointsget
    • Create New Collection Point Versionpost
  • Consent Attachments
    • Upload Consent Attachmentpost
    • Remove Consent Attachmentdelete
    • Download Consent Attachmentget
    • Remove All Consent Attachmentsdelete
    • Download All Consent Attachmentsget
  • Consent Groups
    • Get List of Consent Groupsget
    • Create Consent Grouppost
    • Get Priority Scores for Purpose Statusesget
    • Update Priority Scores for Purpose Statusesput
    • Get Consent Groupget
    • Remove Consent Groups from Parent Consent Groupdelete
    • Add Consent Groups to Parent Consent Grouppost
    • Add Data Subjects to Parent Consent Grouppost
    • Remove Data Subject from Parent Consent Groupdelete
    • Add Purpose Rules to Consent Grouppost
    • Update Consent Group Purpose Ruleput
    • Remove Purpose Rule from Consent Groupdelete
  • Consent Rate Optimization
    • Delete Cross Device Consents and Receiptsdelete
  • Data Subject Groups
    • Get List of Data Subject Groupsget
    • Create Data Subject Grouppost
    • Delete Data Subject Groupdelete
    • Get Data Subject Groupget
    • Update Data Subject Groupput
  • Data Subjects
    • Update Data Subject's Data Elementspost
    • Deduplicate Data Subjectsput
    • Get List of Data Subjectsget
    • Get List of Purposes for a Data Subjectget
  • Data Subjects V2
    • Delete Purpose from Data Subjectsdelete
    • Delete Data Subjectsdelete
    • Get List of Data Subjectsget
    • Delete Purposes from Data Subjectdelete
    • Search Data Subjectspost
  • Data Subjects V3
    • Get List of Data Subjectsget
    • Get Data Subjectget
  • Magic Link Tokens
    • Get List of Data Subject Tokensget
  • Preference Centers
    • Withdraw Data Subject's Consent for All Purposes in a Preference Centerdelete
    • Get Data Subject's Preferences in a Preference Centerget
    • Update Data Subject's Preferences in a Preference Centerput
    • Get Preference Center Schemaget
  • Preference Centers V2
    • Get Preference Center Page Schemaget
    • Get List of Preference Centersget
    • Get Preference Center Root Schemaget
  • Purpose Preferences
    • Get List of Purpose Preferencesget
    • Create Purpose Preferencepost
    • Get Purpose Preferenceget
    • Update Purpose Preferenceput
  • Purposes
    • Get List of Purposesget
    • Create Purposepost
    • Create New Purpose Versionpost
    • Update Purposeput
    • Get List of Data Subjects by Purposeget
    • Publish Purposeput
    • Retire Purposeput
  • Purposes V2
    • Get List of Purpose Versionsget
    • Get Purposeget
  • Receipts
    • Get List of Receipts by Data Subjectget
    • Get List of Receipt Details by Data Subjectget
    • Get Receiptget
  • Receipts V2
    • Get List of Receiptspost
  • Transactions
    • Withdraw Consent on Behalf of a Data Subjectput
    • Withdraw Data Subject's Consentget
  • Transactions V2
    • Get List of Transactionspost
  • Deduplicate Data Subjects
    • Deduplicate Data Subjectspost
    • Generate Export of Duplicate Data Subjectsget
    • Get List of Scheduled Exportsget
    • Create Scheduled Export of Duplicate Data Subjectspost
    • Delete Scheduled Exportdelete
    • Get Scheduled Exportget

Privacy Cloud - Consent & Preference Management (OAS)

  • Magic Link Tokens V4
    • Get Data Subject Tokenget
    • Get List of Data Subject Tokensget
  • Data Subject Groups V4
    • Get List of Data Subject Group Associations by Data Subjectget
    • Get List of Data Subject Group Membersget
  • Data Subjects V4
    • Get List of Data Subjectsget
    • Get Data Subjectget
    • Get Data Subject Detailsget
    • Get List of All Purpose Details by Data Subjectget
    • Get List of All Purpose Details for All Data Subjectsget
    • Get Purpose Details by Data Subjectget

Privacy Cloud - Consent Management Platform

  • Banner
    • Get Banner Dataget
  • Vendors
    • Get IAB and Google Vendorsget
  • Preference Center
    • Get Preference Center Dataget
  • UC Purposes
    • Get Universal Consent Purposesget
  • Log Consent
    • Log Consentpost

Privacy Cloud - Consent Receipts

  • Consent Receipts
    • Create Consent Receiptspost
    • Create Consent Receipts in Bulkpost
    • Create Identified Consent Receiptspost

Privacy Cloud - Cookie Consent

  • Categorizations
    • Categorize Cookies by Domainpost
    • Categorize Cookies by Domain and Cookie IDpost
  • Cookies
    • Create Cookiepost
    • Update Cookieput
    • Get List of Cookies by Criteriapost
  • Scripts
    • Download Script Fileget
    • Publish Script to Websiteput
    • Get Script for Websiteget
  • Websites V2
    • Get List of Websitesget
    • Add Websites to Scanpost
  • Domains
    • Create or Update Domain Grouppost

Privacy Cloud - Cookie Consent (OAS)

  • Cookies
    • Recategorize Cookiesput
    • Get Categorized Cookiespost
    • Add Cookiespost
    • Edit Cookiesput
    • Delete Cookiesdelete
    • Get List of Cookies by Criteriapost
  • Scripts
    • Publish Script to Websiteput
    • Get Script for Websiteget
    • Download Script Fileget
  • Domains
    • Schedule Website Scanspost
    • Delete Domaindelete
    • Cancel Scheduled Website Scanspost
    • Create or Update Domain Grouppost
  • Scans
    • Cancel Scanput
    • Get List of Websitesget
    • Scan Websitespost
    • Get Scan Statusespost
    • Archive Scanspost
    • Get List of Scans by Domainget
    • Get Scan Resultsget
    • Get List of Added or Removed Cookiesget

Privacy Cloud - Cross Device Consent

  • Preferences
    • Get Data Subject's Preferencesget

Privacy Cloud - Consent Interfaces

  • Preferences V2