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

myOneTrust Developer Forum Technology Partners

SDK Reference Recipes API Reference Changelog

myOneTrust Developer Forum Technology Partners Log In

API Reference

SDK Reference Recipes API Reference Changelog

GETTING STARTED

OneTrust API Reference
Quick Start Guide: APIs
OAuth 2.0

api resources

API Rate Limits
API Guides
Supported Languages and HTML Language Codes
OneTrust API Sunsetting & Deprecation Guidelines
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
User Groups

The Trust Intelligence Platform - Authorization

OAuth Token
- Generate Access Tokenpost

The Trust Intelligence Platform - Bulk Export

Bulk Export

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

The Trust Intelligence Platform - Object Manager

Object Attribute Management
Object Relationship Type Management
Object Relationship Management
Object Management
Object Task Management
Object Type Management

The Trust Intelligence Platform - User Provisioning V3

User Groups
Users

The Trust Intelligence Platform - User Provisioning V2

Groups
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

Privacy Cloud - Consent & Preference Management (OAS)

Magic Link Tokens V4
- Get List of Data Subject Tokensget
- Get Data Subject Tokenget
Data Subjects V4

Privacy Cloud - Consent & Preference Management

Collection Points
Collection Points V2
- Get List of Collection Pointsget
- Create New Collection Point Versionpost
Consent Attachments
Consent Groups
Consent Rate Optimization
- Delete Cross Device Consents and Receiptsdelete
Data Subject Groups
Data Subjects
Data Subjects V2
Data Subjects V3
- Get List of Data Subjectsget
- Get Data Subjectget
Magic Link Tokens
- Get List of Data Subject Tokensget
Preference Centers
Preference Centers V2
Purpose Preferences
Purposes
Purposes V2
- Get List of Purpose Versionsget
- Get Purposeget
Receipts
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

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

Privacy Cloud - Cookie Consent

Categorizations
- Categorize Cookies by Domainpost
- Categorize Cookies by Domain and Cookie IDpost
Cookies
Scripts
Websites V2
- Get List of Websitesget
- Add Websites to Scanpost
Domains
- Create or Update Domain Grouppost

Privacy Cloud - Cookie Domain Data

Domain Data
- Get Domain Dataget

Privacy Cloud - Cross Device Consent

Preferences
- Get Data Subject's Preferencesget

Privacy Cloud - Data Catalog Attributes

Data Assets
- Get Data Asset Attributeget
- Get List of Data Asset Attributesget

Privacy Cloud - Data Catalog Glossary

Glossaries
- Get List of Glossariesget
- Get Glossaryget

Privacy Cloud - Data Catalog Metadata Exchange

Catalog Search V1
- Get Catalog Search Resultspost
- Get Search Fieldsget
Catalog Search V2
- Get Catalog Search Resultspost

Privacy Cloud - Data Catalog Tags

Tags

Privacy Cloud - Data Catalog Terms

Terms

Privacy Cloud - Data Discovery

Credentials
Data Sources
Installer
- Get List of Image Tagsget
Scan Jobs
Scan Profiles

Privacy Cloud - Data Discovery Custom Classifier Management

Classification

Privacy Cloud - Data Discovery Worker Node

Custom Scan

Privacy Cloud - Data Mapping Automation

Inventory
Inventory Hierarchies
Inventory Relationships V1
Inventory Relationships V2
Inventory Schema
Personal Data

Privacy Cloud - Incident Management

Incidents

Privacy Cloud - Mobile App Consent

Mobile App Data
- Get SDK Configurationget

Privacy Cloud - Assessment Template

Template

Privacy Cloud - PIA & DPIA Automation

Assessments
Assessment Management
Assessment Actions

Privacy Cloud - Policy & Notice Management

Privacy Notice V2

Privacy Cloud - Privacy Rights Automation

Request Queues
Resolutions
Subtasks
Targeted Data Discovery
Verification Methods

Privacy Cloud - Training

Training

GRC Cloud - Audit Management

Audits
Workpapers

GRC Cloud - Controls

Vulnerabilities
Threats
Controls
Control Implementations
Control Links
- Link Controlspost

GRC Cloud - Enterprise Policy Management

Documents

GRC Cloud - Evidence Tasks

Evidence Task Implementations

GRC Cloud - Risk Automation

Entity Types
- Get List of Risk Entity Typesget
- Get List of Entity Source Typesget
Risk Actions
Risk Management
Risk Relationships
Risks

GRC Cloud - Issues Management

Issues

GRC Cloud - Risk Template

Risk Templates
- Get Risk Templateget

GRC Cloud - Third-Party Risk Management

Contracts
Engagements
Vendors
Vendor Relationships
Inventory Schema
- Get List of Inventory Schemasget
- Get Inventory Schemaget

ESG Cloud - ESG Program Reporting & Disclosures

Metric Details
- Get Metric Detailspost
Carbon Management

GETTING STARTED

OneTrust API Reference
Quick Start Guide: APIs
OAuth 2.0

api resources

API Rate Limits
API Guides
Supported Languages and HTML Language Codes
OneTrust API Sunsetting & Deprecation Guidelines
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
User Groups

The Trust Intelligence Platform - Authorization

OAuth Token
- Generate Access Tokenpost

The Trust Intelligence Platform - Bulk Export

Bulk Export

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

The Trust Intelligence Platform - Object Manager

Object Attribute Management
Object Relationship Type Management
Object Relationship Management
Object Management
Object Task Management
Object Type Management

The Trust Intelligence Platform - User Provisioning V3

User Groups
Users

The Trust Intelligence Platform - User Provisioning V2

Groups
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

Privacy Cloud - Consent & Preference Management (OAS)

Magic Link Tokens V4
- Get List of Data Subject Tokensget
- Get Data Subject Tokenget
Data Subjects V4

Privacy Cloud - Consent & Preference Management

Collection Points
Collection Points V2
- Get List of Collection Pointsget
- Create New Collection Point Versionpost
Consent Attachments
Consent Groups
Consent Rate Optimization
- Delete Cross Device Consents and Receiptsdelete
Data Subject Groups
Data Subjects
Data Subjects V2
Data Subjects V3
- Get List of Data Subjectsget
- Get Data Subjectget
Magic Link Tokens
- Get List of Data Subject Tokensget
Preference Centers
Preference Centers V2
Purpose Preferences
Purposes
Purposes V2
- Get List of Purpose Versionsget
- Get Purposeget
Receipts
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

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

Privacy Cloud - Cookie Consent

Categorizations
- Categorize Cookies by Domainpost
- Categorize Cookies by Domain and Cookie IDpost
Cookies
Scripts
Websites V2
- Get List of Websitesget
- Add Websites to Scanpost
Domains
- Create or Update Domain Grouppost

Privacy Cloud - Cookie Domain Data

Domain Data
- Get Domain Dataget

Privacy Cloud - Cross Device Consent

Preferences
- Get Data Subject's Preferencesget

Privacy Cloud - Data Catalog Attributes

Data Assets
- Get Data Asset Attributeget
- Get List of Data Asset Attributesget

Privacy Cloud - Data Catalog Glossary

Glossaries
- Get List of Glossariesget
- Get Glossaryget

Privacy Cloud - Data Catalog Metadata Exchange

Catalog Search V1
- Get Catalog Search Resultspost
- Get Search Fieldsget
Catalog Search V2
- Get Catalog Search Resultspost

Privacy Cloud - Data Catalog Tags

Tags

Privacy Cloud - Data Catalog Terms

Terms

Privacy Cloud - Data Discovery

Credentials
Data Sources
Installer
- Get List of Image Tagsget
Scan Jobs
Scan Profiles

Privacy Cloud - Data Discovery Custom Classifier Management

Classification

Privacy Cloud - Data Discovery Worker Node

Custom Scan

Privacy Cloud - Data Mapping Automation

Inventory
Inventory Hierarchies
Inventory Relationships V1
Inventory Relationships V2
Inventory Schema
Personal Data

Privacy Cloud - Incident Management

Incidents

Privacy Cloud - Mobile App Consent

Mobile App Data
- Get SDK Configurationget

Privacy Cloud - Assessment Template

Template

Privacy Cloud - PIA & DPIA Automation

Assessments
Assessment Management
Assessment Actions

Privacy Cloud - Policy & Notice Management

Privacy Notice V2

Privacy Cloud - Privacy Rights Automation

Request Queues
Resolutions
Subtasks
Targeted Data Discovery
Verification Methods

Privacy Cloud - Training

Training

GRC Cloud - Audit Management

Audits
Workpapers

GRC Cloud - Controls

Vulnerabilities
Threats
Controls
Control Implementations
Control Links
- Link Controlspost

GRC Cloud - Enterprise Policy Management

Documents

GRC Cloud - Evidence Tasks

Evidence Task Implementations

GRC Cloud - Risk Automation

Entity Types
- Get List of Risk Entity Typesget
- Get List of Entity Source Typesget
Risk Actions
Risk Management
Risk Relationships
Risks

GRC Cloud - Issues Management

Issues

GRC Cloud - Risk Template

Risk Templates
- Get Risk Templateget

GRC Cloud - Third-Party Risk Management

Contracts
Engagements
Vendors
Vendor Relationships
Inventory Schema
- Get List of Inventory Schemasget
- Get Inventory Schemaget

ESG Cloud - ESG Program Reporting & Disclosures

Metric Details
- Get Metric Detailspost
Carbon Management

Get Bulk Export Credit Details

get https://{hostname}/api/ot-insights/v1/bulk-export-jobs/credits

Language

Credentials

OAuth2

Bearer

URL

👋 Hi there!

Start Learning. Start Building. Start Launching! 🚀

These resources can help you get started:

Did this page help you?

Please enter your feedback. Feedback submitted successfully!

Get Help

Contact Support

Scheduled Maintenance

Groups

Developer Experience

Knowledge Base

Resources

OneTrust Partner List

Product Updates

OneTrust Roadmap

Release Webinars

Talks Tech Podcast

© 2024 ONETRUST. ALL RIGHTS RESERVED.