# OneTrust Developer Portal Documentation

## Guides
- [Data Discovery Connector SDK](https://developer.onetrust.com/onetrust/docs/adding-sdk-to-app.md)
- [Command queue for embedded web forms](https://developer.onetrust.com/onetrust/docs/command-queue.md)
- [Common SDK Methods (External web form)](https://developer.onetrust.com/onetrust/docs/common-sdk-methods.md)
- [Embedded web forms methods and events](https://developer.onetrust.com/onetrust/docs/embedded-web-forms-methods-and-events.md)
- [Web Form Collection Point JavaScript SDK](https://developer.onetrust.com/onetrust/docs/getting-started-1.md)
- [Sample JavaScript SDK and Instructions](https://developer.onetrust.com/onetrust/docs/sample-javascript-sdk-and-instructions.md)
- [Trigger Collection Points](https://developer.onetrust.com/onetrust/docs/trigger-collection-points.md)
- [Cross Domain and Cross Device Consent](https://developer.onetrust.com/onetrust/docs/cross-domain-cross-device.md)
- [Managing Known Users](https://developer.onetrust.com/onetrust/docs/managing-known-users.md): Understand how to configure your OneTrust CMP and Universal Consent & Preference Management tools when your audience is identified
- [Unified Profile](https://developer.onetrust.com/onetrust/docs/unified-profile.md): Learn how to save a user's CMP preferences onto their Universal Consent profile.
- [IAB TC String Encoder](https://developer.onetrust.com/onetrust/docs/tc-string-encoder.md)
- [OneTrust SDK Reference](https://developer.onetrust.com/onetrust/docs/onetrust-sdk-reference.md)
- [Mobile & OTT/CTV SDKs](https://developer.onetrust.com/onetrust/docs/mobile-ctv.md)
- [Scanning and Categorizing SDKs](https://developer.onetrust.com/onetrust/docs/app-scanning.md)
- [How App Scanner Works](https://developer.onetrust.com/onetrust/docs/how-app-scanner-works.md)
- [Publish Changes](https://developer.onetrust.com/onetrust/docs/publish-changes.md)
- [Scan Apps via API](https://developer.onetrust.com/onetrust/docs/scan-apps-via-api.md)
- [OneTrust Hands-On Lab](https://developer.onetrust.com/onetrust/docs/taking-a-onetrust-hands-on-lab.md)
- [POST /classifications/v1](https://developer.onetrust.com/onetrust/docs/ai-guard-api-classify.md)
- [GET /health](https://developer.onetrust.com/onetrust/docs/ai-guard-api-health.md)
- [POST /metric](https://developer.onetrust.com/onetrust/docs/ai-guard-api-metric.md)
- [API Overview](https://developer.onetrust.com/onetrust/docs/ai-guard-api-overview.md)
- [Authentication & Authorization](https://developer.onetrust.com/onetrust/docs/ai-guard-authentication.md)
- [Classification Profiles](https://developer.onetrust.com/onetrust/docs/ai-guard-classification-profiles.md)
- [Service Configuration](https://developer.onetrust.com/onetrust/docs/ai-guard-service-configuration.md)
- [TLS & Certificate Pinning](https://developer.onetrust.com/onetrust/docs/ai-guard-tls-certificate-pinning.md)
- [Docker Deployment](https://developer.onetrust.com/onetrust/docs/ai-guard-docker.md)
- [Kubernetes Deployment](https://developer.onetrust.com/onetrust/docs/ai-guard-kubernetes.md)
- [Networking Requirements](https://developer.onetrust.com/onetrust/docs/ai-guard-networking.md)
- [Error Reference](https://developer.onetrust.com/onetrust/docs/ai-guard-error-reference.md)
- [FAQ](https://developer.onetrust.com/onetrust/docs/ai-guard-faq.md)
- [Create an API Key](https://developer.onetrust.com/onetrust/docs/ai-guard-create-api-key.md)
- [Deploy the Light Worker Node](https://developer.onetrust.com/onetrust/docs/ai-guard-deploy-worker-node.md)
- [Install the SDK](https://developer.onetrust.com/onetrust/docs/ai-guard-install-sdk.md)
- [Prerequisites](https://developer.onetrust.com/onetrust/docs/ai-guard-prerequisites.md)
- [Metrics Exporters](https://developer.onetrust.com/onetrust/docs/ai-guard-exporters.md)
- [Meter Definitions](https://developer.onetrust.com/onetrust/docs/ai-guard-meters.md)
- [Metrics Overview](https://developer.onetrust.com/onetrust/docs/ai-guard-metrics-overview.md)
- [Classify Text](https://developer.onetrust.com/onetrust/docs/ai-guard-classification.md)
- [Classifier Descriptions](https://developer.onetrust.com/onetrust/docs/ai-guard-classifier-descriptions.md)
- [Initializing the Client](https://developer.onetrust.com/onetrust/docs/ai-guard-initializing-the-client.md)
- [Observability & Metrics](https://developer.onetrust.com/onetrust/docs/ai-guard-metrics.md)
- [Redact Sensitive Data](https://developer.onetrust.com/onetrust/docs/ai-guard-redaction.md)
- [Streaming Classification](https://developer.onetrust.com/onetrust/docs/ai-guard-streaming.md)
- [Troubleshooting](https://developer.onetrust.com/onetrust/docs/ai-guard-troubleshooting.md)
- [AI Guard](https://developer.onetrust.com/onetrust/docs/ai-guard.md)
- [API Reference](https://developer.onetrust.com/onetrust/docs/api-reference-android-legacy.md)
- [CNIL Continue Without Accepting](https://developer.onetrust.com/onetrust/docs/cnil-continue-without-accepting-android-legacy.md)
- [Google Advertising ID](https://developer.onetrust.com/onetrust/docs/google-advertising-id-android-legacy.md)
- [Google Consent Mode](https://developer.onetrust.com/onetrust/docs/google-consent-mode-android-legacy.md)
- [IAB CCPA US Privacy String](https://developer.onetrust.com/onetrust/docs/iab-ccpa-us-privacy-string-android-legacy.md)
- [IAB Global Privacy Protocol](https://developer.onetrust.com/onetrust/docs/iab-global-privacy-platform-legacy.md)
- [IAB TCF 2.2](https://developer.onetrust.com/onetrust/docs/iab-tcf-22-android-legacy.md)
- [Multi Profile Consent](https://developer.onetrust.com/onetrust/docs/multi-profile-consent-legacy.md)
- [Passing Consent to WebView](https://developer.onetrust.com/onetrust/docs/pass-consent-to-webview-android-legacy.md)
- [Proxying SDK Network Calls](https://developer.onetrust.com/onetrust/docs/proxying-sdk-network-calls-android-legacy.md)
- [SDK Logging](https://developer.onetrust.com/onetrust/docs/sdk-logging-android-legacy.md)
- [Universal Consent Purposes](https://developer.onetrust.com/onetrust/docs/universal-consent-purposes-android-legacy.md)
- [Changelog](https://developer.onetrust.com/onetrust/docs/changelog-android-legacy.md)
- [Adding SDK to App](https://developer.onetrust.com/onetrust/docs/adding-sdk-to-app-android-legacy.md)
- [Customize User Interfaces](https://developer.onetrust.com/onetrust/docs/customize-user-interfaces-android-legacy.md)
- [Display User Interfaces](https://developer.onetrust.com/onetrust/docs/display-user-interfaces-android-legacy.md)
- [Download and Import SDK](https://developer.onetrust.com/onetrust/docs/download-the-sdk-android-legacy.md)
- [Initialize SDK](https://developer.onetrust.com/onetrust/docs/initialize-the-sdk-android-legacy.md)
- [Sample App](https://developer.onetrust.com/onetrust/docs/sample-app-android-legacy.md)
- [When Consent Changes](https://developer.onetrust.com/onetrust/docs/when-consent-changes-android-legacy.md)
- [Android SDK (Legacy)](https://developer.onetrust.com/onetrust/docs/android-legacy.md)
- [API Reference](https://developer.onetrust.com/onetrust/docs/api-reference-android-next-gen.md)
- [CNIL Continue Without Accepting](https://developer.onetrust.com/onetrust/docs/cnil-continue-without-accepting-android-next-gen.md)
- [Google Advertising ID](https://developer.onetrust.com/onetrust/docs/google-advertising-id-android-next-gen.md)
- [Google Consent Mode](https://developer.onetrust.com/onetrust/docs/google-consent-mode-android-next-gen.md)
- [IAB CCPA US Privacy String](https://developer.onetrust.com/onetrust/docs/iab-ccpa-us-privacy-string-android-next-gen.md)
- [IAB Global Privacy Protocol](https://developer.onetrust.com/onetrust/docs/iab-global-privacy-protocol-android-next-gen.md)
- [IAB Transparency and Consent Framework (TCF)](https://developer.onetrust.com/onetrust/docs/iab-tcf-android-next-gen.md)
- [Multi Profile Consent](https://developer.onetrust.com/onetrust/docs/multi-profile-consent-android-next-gen.md)
- [Passing Consent to WebView](https://developer.onetrust.com/onetrust/docs/passing-consent-to-webview-android-next-gen.md)
- [Proxy SDK Network Calls](https://developer.onetrust.com/onetrust/docs/proxy-sdk-network-calls-android-next-gen.md)
- [SDK Logging](https://developer.onetrust.com/onetrust/docs/sdk-logging-android-next-gen.md)
- [Universal Consent Purposes](https://developer.onetrust.com/onetrust/docs/universal-consent-purposes-android-next-gen.md)
- [CMP Configuration Data](https://developer.onetrust.com/onetrust/docs/android-legacy-deprecated-methods-cmp-configuration-data.md)
- [Legacy to Next Gen SDK Deprecated Methods](https://developer.onetrust.com/onetrust/docs/android-legacy-to-next-gen-sdk-deprecated-methods.md)
- [Customize User Interfaces](https://developer.onetrust.com/onetrust/docs/customize-user-interfaces-android-next-gen.md)
- [Display User Interfaces](https://developer.onetrust.com/onetrust/docs/display-user-interfaces-android-next-gen.md)
- [Download and Import the SDK](https://developer.onetrust.com/onetrust/docs/download-and-import-sdk-to-app-android-next-gen.md)
- [Initialize the SDK](https://developer.onetrust.com/onetrust/docs/initialize-sdk-android-next-gen.md)
- [Sample App](https://developer.onetrust.com/onetrust/docs/sample-app-android-next-gen.md)
- [When Consent Changes](https://developer.onetrust.com/onetrust/docs/when-consent-changes-android-next-gen.md)
- [Android SDK](https://developer.onetrust.com/onetrust/docs/android-sdk-next-gen.md)
- [Cordova / Ionic](https://developer.onetrust.com/onetrust/docs/cordova-ionic.md): The OneTrust Cordova/Ionic library is hosted on [NPM](https://www.npmjs.com/package/cordova-plugin-onetrust-cmp).
- [Flutter](https://developer.onetrust.com/onetrust/docs/flutter.md): The OneTrust Flutter library is hosted on [pub.dev](https://pub.dev/packages/onetrust_publishers_native_cmp).
- [Frameworks](https://developer.onetrust.com/onetrust/docs/frameworks.md)
- [React Native](https://developer.onetrust.com/onetrust/docs/react-native.md): The OneTrust React Native library is hosted on [NPM](https://www.npmjs.com/package/react-native-onetrust-cmp).
- [API Reference](https://developer.onetrust.com/onetrust/docs/api-reference-ios-tvos-legacy.md): OneTrust iOS SDK Public Methods
- [App Tracking Transparency](https://developer.onetrust.com/onetrust/docs/app-tracking-transparency-ios-tvos-legacy.md)
- [CNIL Continue Without Accepting](https://developer.onetrust.com/onetrust/docs/cnil-continue-without-accepting-ios-tvos-legacy.md)
- [Google Consent Mode](https://developer.onetrust.com/onetrust/docs/google-consent-mode-ios-legacy.md)
- [IAB CCPA US Privacy String](https://developer.onetrust.com/onetrust/docs/iab-ccpa-us-privacy-string-ios-tvos-legacy.md)
- [IAB Global Privacy Protocol](https://developer.onetrust.com/onetrust/docs/iab-global-privacy-platform-1-legacy.md)
- [IAB TCF 2.2](https://developer.onetrust.com/onetrust/docs/iab-tcf-22-ios-tvos-legacy.md)
- [Multi Profile Consent](https://developer.onetrust.com/onetrust/docs/multi-profile-consent-ios-legacy.md)
- [Passing Consent to WebView](https://developer.onetrust.com/onetrust/docs/passing-consent-to-webview-ios-tvos-legacy.md)
- [Proxying SDK Network Calls](https://developer.onetrust.com/onetrust/docs/proxying-sdk-network-calls-ios-legacy.md)
- [SDK Logging](https://developer.onetrust.com/onetrust/docs/sdk-logging-ios-tvos-legacy.md)
- [Universal Consent Purposes](https://developer.onetrust.com/onetrust/docs/universal-consent-purposes-legacy.md)
- [Changelog](https://developer.onetrust.com/onetrust/docs/changelog-ios-tvos-legacy.md)
- [Add SDK to App](https://developer.onetrust.com/onetrust/docs/add-sdk-to-app-ios-tvos-legacy.md)
- [Customize User Interfaces](https://developer.onetrust.com/onetrust/docs/customize-user-interfaces-ios-tvos-legacy.md)
- [Display User Interfaces](https://developer.onetrust.com/onetrust/docs/display-user-interfaces-ios-tvos-legacy.md)
- [Download the SDK](https://developer.onetrust.com/onetrust/docs/download-the-sdk-ios-tvos-legacy.md)
- [Initialize SDK](https://developer.onetrust.com/onetrust/docs/initialize-the-sdk-ios-tvos-legacy.md)
- [Sample App](https://developer.onetrust.com/onetrust/docs/sample-app-ios-tvos-legacy.md)
- [When Consent Changes](https://developer.onetrust.com/onetrust/docs/when-consent-changes-ios-legacy.md)
- [iOS & tvOS SDK (Legacy)](https://developer.onetrust.com/onetrust/docs/ios-tvos-legacy.md)
- [App Tracking Transparency](https://developer.onetrust.com/onetrust/docs/app-tracking-transparency-ios-next-gen.md)
- [Customize User Interfaces (Optional)](https://developer.onetrust.com/onetrust/docs/customize-user-interfaces-ios-next-gen.md)
- [Google Consent Mode](https://developer.onetrust.com/onetrust/docs/google-consent-mode-ios-next-gen.md)
- [IAB CCPA US Privacy String](https://developer.onetrust.com/onetrust/docs/iab-ccpa-us-privacy-string-ios-next-gen.md)
- [IAB Global Privacy Protocol](https://developer.onetrust.com/onetrust/docs/iab-global-privacy-protocol-ios-next-gen.md)
- [IAB Transparency and Consent Framework (TCF)](https://developer.onetrust.com/onetrust/docs/iab-tcf-22-ios-next-gen.md)
- [Multi Profile Consent](https://developer.onetrust.com/onetrust/docs/multi-profile-consent-ios-next-gen.md)
- [Passing Consent to WebView](https://developer.onetrust.com/onetrust/docs/passing-consent-to-webview-ios-next-gen.md)
- [Proxying SDK Network Calls](https://developer.onetrust.com/onetrust/docs/proxying-sdk-network-calls-ios-next-gen.md)
- [SDK Logging](https://developer.onetrust.com/onetrust/docs/sdk-logging-ios-next-gen.md)
- [Universal Consent Purposes](https://developer.onetrust.com/onetrust/docs/universal-consent-purposes-ios-next-gen.md)
- [Additional Information](https://developer.onetrust.com/onetrust/docs/additional-information.md): Additional information on OneTrust iOS SDK public methods
- [Groups (Categories/Purposes) Helpers](https://developer.onetrust.com/onetrust/docs/groups-categoriespurposes.md): OneTrust SDK Public Methods for Groups (Categories/Purposes)
- [Multi-Profile](https://developer.onetrust.com/onetrust/docs/multi-profile.md): OneTrust SDK Public Methods for Multi Profile Consent
- [OneTrust SDK Additional Helpers](https://developer.onetrust.com/onetrust/docs/onetrust-sdk-additional-helpers.md): OneTrust SDK Public Methods for Saving Consent and Additional use-cases
- [OneTrust SDK Helpers](https://developer.onetrust.com/onetrust/docs/onetrust-sdk-helpers.md): OneTrust iOS SDK Public Methods for Initial SDK Setup
- [OneTrust UI Helpers](https://developer.onetrust.com/onetrust/docs/onetrust-ui-helpers.md): OneTrust SDK Public Methods for Showing the User Interfaces
- [Prompts](https://developer.onetrust.com/onetrust/docs/prompts-att-and-age-gate.md): OneTrust SDK Public Methods for Apple Tracking Transparency(ATT) and Age Gate Prompts
- [Proxy](https://developer.onetrust.com/onetrust/docs/proxy.md): OneTrust SDK Public Methods for setting up Proxy configuration for OneTrust network calls
- [SDK List Helpers](https://developer.onetrust.com/onetrust/docs/sdk-list.md): OneTrust SDK Public Methods for First Party SDKs
- [Universal Consent Purposes Helpers](https://developer.onetrust.com/onetrust/docs/universal-consent-purposes-ucp-helpers.md): OneTrust SDK Public Methods for Universal Consent Purposes (UCP)
- [Vendors Helpers](https://developer.onetrust.com/onetrust/docs/vendors-helpers.md): OneTrust SDK Public Methods for IAB and Google Vendors
- [Display User Interfaces](https://developer.onetrust.com/onetrust/docs/display-user-interfaces-ios-next-gen.md)
- [Download and Import the SDK](https://developer.onetrust.com/onetrust/docs/download-the-sdk-ios-next-gen.md)
- [Initialize the SDK](https://developer.onetrust.com/onetrust/docs/initialize-sdk-next-gen.md)
- [Sample App](https://developer.onetrust.com/onetrust/docs/sample-app-ios-tvos-next-gen.md)
- [When Consent Changes](https://developer.onetrust.com/onetrust/docs/when-consent-changes-ios-next-gen.md)
- [iOS & tvOS SDK](https://developer.onetrust.com/onetrust/docs/ios-tvos-sdk-next-gen.md)
- [Legacy to Next Gen SDK Deprecated Methods](https://developer.onetrust.com/onetrust/docs/ios-legacy-to-next-gen-sdk-deprecated-methods.md)
- [CMP Configuration Data](https://developer.onetrust.com/onetrust/docs/ios-legacy-deprecated-methods-cmp-configuration-data.md)
- [General Vendors and IAB Data](https://developer.onetrust.com/onetrust/docs/ios-legacy-deprecated-methods-general-vendors-and-iab-data.md)
- [Proxy](https://developer.onetrust.com/onetrust/docs/ios-legacy-deprecated-methods-proxy.md)
- [Universal Consent Data](https://developer.onetrust.com/onetrust/docs/ios-legacy-deprecated-methods-universal-consent-data.md)
- [API Reference](https://developer.onetrust.com/onetrust/docs/api-reference-maui-new.md)
- [IAB CCPA US Privacy String](https://developer.onetrust.com/onetrust/docs/iab-ccpa-us-privacy-string-maui-new.md)
- [IAB Global Privacy Protocol](https://developer.onetrust.com/onetrust/docs/iab-global-privacy-protocol-maui-new.md)
- [IAB Transparency and Consent Framework (TCF)](https://developer.onetrust.com/onetrust/docs/iab-tcf-22-maui-new.md)
- [Add SDK to App](https://developer.onetrust.com/onetrust/docs/add-sdk-to-app-maui-new.md)
- [Customize User Interfaces](https://developer.onetrust.com/onetrust/docs/customize-user-interfaces-maui-new.md)
- [Display User Interfaces](https://developer.onetrust.com/onetrust/docs/display-user-interfaces-maui-new.md)
- [Download the SDK](https://developer.onetrust.com/onetrust/docs/download-the-sdk-maui-new.md)
- [Initialize the SDK](https://developer.onetrust.com/onetrust/docs/initialize-the-sdk-maui-new.md)
- [When Consent Changes](https://developer.onetrust.com/onetrust/docs/when-consent-changes-maui-new.md)
- [MAUI and Unity SDK](https://developer.onetrust.com/onetrust/docs/maui-and-unity-sdk-new.md)
- [API Reference](https://developer.onetrust.com/onetrust/docs/api-reference-maui-legacy.md)
- [IAB CCPA US Privacy String](https://developer.onetrust.com/onetrust/docs/iab-ccpa-us-privacy-string-maui-legacy.md)
- [IAB Global Privacy Protocol](https://developer.onetrust.com/onetrust/docs/iab-global-privacy-platform-maui-legacy.md)
- [IAB TCF 2.2](https://developer.onetrust.com/onetrust/docs/iab-tcf-22-maui-legacy.md)
- [Changelog](https://developer.onetrust.com/onetrust/docs/changelog-xamarin-unity.md)
- [Add SDK to App](https://developer.onetrust.com/onetrust/docs/add-sdk-to-app-maui-legacy.md)
- [Customize User Interfaces](https://developer.onetrust.com/onetrust/docs/customize-user-interfaces-maui-legacy.md)
- [Display User Interfaces](https://developer.onetrust.com/onetrust/docs/display-user-interfaces-maui-legacy.md)
- [Download the SDK](https://developer.onetrust.com/onetrust/docs/download-the-sdk-maui-legacy.md)
- [Initialize the SDK](https://developer.onetrust.com/onetrust/docs/initialize-the-sdk-maui-legacy.md)
- [When Consent Changes](https://developer.onetrust.com/onetrust/docs/when-consent-changes-maui-legacy.md)
- [MAUI and Unity SDK (Legacy)](https://developer.onetrust.com/onetrust/docs/maui-legacy.md)
- [OneTrust Next Generation CMP SDKs](https://developer.onetrust.com/onetrust/docs/onetrusts-next-generation-cmp-sdks.md)
- [Release Notes](https://developer.onetrust.com/onetrust/docs/release-notes.md)
- [Cross Device and Domain Consent - Roku](https://developer.onetrust.com/onetrust/docs/cross-device-consent-legacy.md)
- [IAB CCPA US Privacy String](https://developer.onetrust.com/onetrust/docs/iab-ccpa-us-privacy-string-roku-legacy.md)
- [IAB Global Privacy Protocol](https://developer.onetrust.com/onetrust/docs/iab-global-privacy-platform-2-legacy.md)
- [IAB TCF 2.2](https://developer.onetrust.com/onetrust/docs/iab-tcf-22-1-legacy.md)
- [Changelog](https://developer.onetrust.com/onetrust/docs/changelog-roku.md)
- [Add SDK to App](https://developer.onetrust.com/onetrust/docs/add-sdk-to-app-roku-legacy.md)
- [Display User Interfaces](https://developer.onetrust.com/onetrust/docs/display-user-interfaces-roku-legacy.md)
- [Download the SDK](https://developer.onetrust.com/onetrust/docs/download-sdk-roku-legacy.md)
- [Initialize the SDK](https://developer.onetrust.com/onetrust/docs/initialize-the-sdk-roku-legacy.md)
- [When Consent Changes](https://developer.onetrust.com/onetrust/docs/when-consent-changes-roku-legacy.md)
- [Roku SDK (Legacy)](https://developer.onetrust.com/onetrust/docs/roku-legacy.md)
- [API Reference](https://developer.onetrust.com/onetrust/docs/api-reference-roku-next-gen.md)
- [Cross Device and Cross Domain Consent](https://developer.onetrust.com/onetrust/docs/cross-device-consent-roku-next-gen.md)
- [IAB CCPA US Privacy String](https://developer.onetrust.com/onetrust/docs/iab-ccpa-us-privacy-string-roku-next-gen.md)
- [IAB Global Privacy Protocol](https://developer.onetrust.com/onetrust/docs/iab-global-privacy-protocol-roku-next-gen.md)
- [IAB Transparency and Consent Framework (TCF)](https://developer.onetrust.com/onetrust/docs/iab-tcf-22-roku-next-gen.md)
- [Multi Profile Consent](https://developer.onetrust.com/onetrust/docs/multi-profile-consent-roku-next-gen.md)
- [Display User Interfaces](https://developer.onetrust.com/onetrust/docs/display-user-interfaces-roku-next-gen.md)
- [Download and Import the SDK](https://developer.onetrust.com/onetrust/docs/download-the-sdk-roku-next-gen.md)
- [Initialize the SDK](https://developer.onetrust.com/onetrust/docs/initialize-the-sdk-roku-next-gen.md)
- [When Consent Changes](https://developer.onetrust.com/onetrust/docs/when-consent-changes-roku-next-gen.md)
- [Roku SDK](https://developer.onetrust.com/onetrust/docs/roku-new.md)
- [API Reference](https://developer.onetrust.com/onetrust/docs/api-reference.md)
- [IAB CCPA US Privacy String](https://developer.onetrust.com/onetrust/docs/iab-ccpa-us-privacy-string-1.md)
- [IAB Global Privacy Protocol](https://developer.onetrust.com/onetrust/docs/iab-global-privacy-platform-4.md)
- [IAB TCF 2.2](https://developer.onetrust.com/onetrust/docs/iab-tcf-22.md)
- [SDK Logging](https://developer.onetrust.com/onetrust/docs/sdk-logging.md)
- [Configure SDK Parameters](https://developer.onetrust.com/onetrust/docs/configure-sdk-parameters.md)
- [Display User Interfaces](https://developer.onetrust.com/onetrust/docs/display-user-interfaces.md)
- [Download SDK](https://developer.onetrust.com/onetrust/docs/download-sdk.md)
- [When Consent Changes](https://developer.onetrust.com/onetrust/docs/when-consent-changes.md)
- [HTML5 SDK - Tizen and WebOS (Legacy)](https://developer.onetrust.com/onetrust/docs/tizen-and-webos-sdk-legacy.md)
- [IAB CCPA US Privacy String](https://developer.onetrust.com/onetrust/docs/iab-ccpa-us-privacy-string-new.md)
- [IAB Global Privacy Protocol](https://developer.onetrust.com/onetrust/docs/iab-global-privacy-protocol-new.md)
- [IAB Transparency and Consent Framework (TCF)](https://developer.onetrust.com/onetrust/docs/iab-tcf-22-new.md)
- [Right-To-Left (RTL) Support](https://developer.onetrust.com/onetrust/docs/rtl-support.md)
- [Initialize the SDK](https://developer.onetrust.com/onetrust/docs/configure-sdk-parameters-new.md)
- [Display User Interfaces](https://developer.onetrust.com/onetrust/docs/display-user-interfaces-new.md)
- [Download the SDK](https://developer.onetrust.com/onetrust/docs/download-sdk-new.md)
- [Migrating from the Legacy SDK to the CMP API](https://developer.onetrust.com/onetrust/docs/migrating-from-the-legacy-sdk-to-the-new-cmp-sdk.md): This page is only relevant if you are using a legacy SDK and need to adopt the CMP API solution.
- [When Consent Changes](https://developer.onetrust.com/onetrust/docs/when-consent-changes-new.md)
- [HTML5 SDK - Tizen and WebOS](https://developer.onetrust.com/onetrust/docs/tizen-and-webos-sdk-new.md)
- [URLs called by the OneTrust Mobile SDKs](https://developer.onetrust.com/onetrust/docs/urls-called-by-the-onetrust-sdk.md)
- [IAB Global Privacy Protocol](https://developer.onetrust.com/onetrust/docs/iab-gpp.md)
- [IAB TCF 2.3](https://developer.onetrust.com/onetrust/docs/iab-transparency-and-consent-framework-22.md)
- [Get Banner UI](https://developer.onetrust.com/onetrust/docs/get-banner-ui.md): Retrieve the required attributes to render the banner UI
- [Get Preference Center UI](https://developer.onetrust.com/onetrust/docs/get-preference-center-ui.md): Retrieve the required attributes to render the preference center UI
- [Get Universal Consent Preferences UI](https://developer.onetrust.com/onetrust/docs/get-universal-consent-preferences.md): Retrieve the required attributes to render the Mobile Universal Consent Preference Center UI
- [Get Vendor List UI](https://developer.onetrust.com/onetrust/docs/get-vendor-list-ui.md): Retrieve the required attributes to render the vendor list UI
- [Implementation Guidance](https://developer.onetrust.com/onetrust/docs/implementation-guidance.md): This page walks you through how to implement the CMP API solution in your application.
- [Persisting Consent](https://developer.onetrust.com/onetrust/docs/persisting-consent.md): This page describes how consent persists from one instance to the next.
- [Save and Log Consent](https://developer.onetrust.com/onetrust/docs/save-and-log-consent.md): Save and log consent to OneTrust servers.
- [Introduction](https://developer.onetrust.com/onetrust/docs/server-side-cmp-api-introduction.md)
- [AMP Integration](https://developer.onetrust.com/onetrust/docs/amp-integration.md)
- [Bulk Domain Management](https://developer.onetrust.com/onetrust/docs/bulk-domain-management.md)
- [Custom Common CSS and JavaScript](https://developer.onetrust.com/onetrust/docs/common-custom-css.md)
- [Configuring a Content Security Policy with OneTrust CDN](https://developer.onetrust.com/onetrust/docs/content-security-policy-cdn.md)
- [Cookie Consent Support for AMP Websites](https://developer.onetrust.com/onetrust/docs/cookie-consent-support-for-amp-websites.md)
- [Custom Common HTML](https://developer.onetrust.com/onetrust/docs/custom-common-html.md)
- [Custom Geolocation Integration](https://developer.onetrust.com/onetrust/docs/custom-geolocation-integration.md)
- [Display Preference Center on Script Load](https://developer.onetrust.com/onetrust/docs/display-preference-center.md)
- [PRA/DSAR - Web CMP Opt Out](https://developer.onetrust.com/onetrust/docs/dsarpra-web-cmp-opt-out.md)
- [IAB CCPA: Configuring the US Privacy String](https://developer.onetrust.com/onetrust/docs/iab-ccpa-us-privacy-string.md)
- [IAB TCF Developer Guide](https://developer.onetrust.com/onetrust/docs/iab-tcf-developer-guide.md)
- [Web CMP JavaScript Methods](https://developer.onetrust.com/onetrust/docs/javascript-api.md): This page provides a list of all public methods exposed by the Web CMP script.
- [Web CMP Events Guide](https://developer.onetrust.com/onetrust/docs/javascript-events-guide.md)
- [Multi-Touch Consent](https://developer.onetrust.com/onetrust/docs/multi-touch-consent.md)
- [Server Side Rendering Performance & Availability](https://developer.onetrust.com/onetrust/docs/server-side-rendering-performance-availability.md)
- [Single Page Applications](https://developer.onetrust.com/onetrust/docs/single-page-applications.md)
- [Google Consent Mode](https://developer.onetrust.com/onetrust/docs/using-google-consent-mode.md)
- [Using TCF with Header Bidding (TCF Stub)](https://developer.onetrust.com/onetrust/docs/using-tcf-with-header-bidding.md)
- [Using TCF with Prebid](https://developer.onetrust.com/onetrust/docs/using-tcf-with-prebid.md)
- [BigCommerce](https://developer.onetrust.com/onetrust/docs/bigcommerce.md)
- [Shopify](https://developer.onetrust.com/onetrust/docs/ecommerce.md)
- [Ensighten](https://developer.onetrust.com/onetrust/docs/ensighten.md)
- [Facebook Pixel](https://developer.onetrust.com/onetrust/docs/facebook-pixel.md)
- [Google Tag Manager](https://developer.onetrust.com/onetrust/docs/google-tag-manager.md)
- [HubSpot](https://developer.onetrust.com/onetrust/docs/hubspot.md)
- [Connecting the OneTrust CMP to Third-Party Platforms](https://developer.onetrust.com/onetrust/docs/connect-cmp-to-third-party-platforms.md)
- [Magento](https://developer.onetrust.com/onetrust/docs/magento.md)
- [Marketo Landing Page](https://developer.onetrust.com/onetrust/docs/marketo-landing-page.md)
- [mParticle](https://developer.onetrust.com/onetrust/docs/mparticle.md)
- [Squarespace](https://developer.onetrust.com/onetrust/docs/squarespace.md)
- [Tealium Tag Manager](https://developer.onetrust.com/onetrust/docs/tealium-tag-manager.md)
- [Weebly](https://developer.onetrust.com/onetrust/docs/weebly.md)
- [Performance and Availability of the Cookie Consent Script](https://developer.onetrust.com/onetrust/docs/performance-availability-cookie-script.md)

## API Reference
- [Get List of Relationship Records by Entity](https://developer.onetrust.com/onetrust/reference/getrelatedentitiesforanentityusingpost.md): Use this API to retrieve a list of relationship records by entity. > 🗒 Things to Know> > - This API only supports AI Governance entities (Models, Datasets, AI Systems, and AI Agents).> - AI Governance APIs will become available over the course of the Spring as customer tenants are migrated to enhanced AI Governance services. No customer action is required and more detailed information will be published in upcoming release notes and product documentation.
- [Add Attribute to Schema](https://developer.onetrust.com/onetrust/reference/addattributeusingpost.md): Use this API to add an attribute to a specific schema.  > 🗒 Things to Know >  > - This API only supports AI Governance entities (Models, Datasets, AI Systems, and AI Agents). > - AI Governance APIs will become available over the course of the Spring as customer tenants are migrated to enhanced AI Governance services. No customer action is required and more detailed information will be published in upcoming release notes and product documentation.
- [Add Options to Attribute](https://developer.onetrust.com/onetrust/reference/addoptionsusingpost-1.md): Use this API to add options to an attribute.  > 🗒 Things to Know >  > - This API only supports AI Governance entities (Models, Datasets, AI Systems, and AI Agents). > - AI Governance APIs will become available over the course of the Spring as customer tenants are migrated to enhanced AI Governance services. No customer action is required and more detailed information will be published in upcoming release notes and product documentation.
- [Disable Attribute](https://developer.onetrust.com/onetrust/reference/disableattributeusingput-1.md): Use this API to disable an attribute.  > 🗒 Things to Know >  > - This API only supports AI Governance entities (Models, Datasets, AI Systems, and AI Agents). > - AI Governance APIs will become available over the course of the Spring as customer tenants are migrated to enhanced AI Governance services. No customer action is required and more detailed information will be published in upcoming release notes and product documentation.
- [Enable Attribute](https://developer.onetrust.com/onetrust/reference/enableattributeusingput-1.md): Use this API to enable an attribute.  > 🗒 Things to Know >  > - This API only supports AI Governance entities (Models, Datasets, AI Systems, and AI Agents). > - AI Governance APIs will become available over the course of the Spring as customer tenants are migrated to enhanced AI Governance services. No customer action is required and more detailed information will be published in upcoming release notes and product documentation.
- [Create Entity](https://developer.onetrust.com/onetrust/reference/addentityusingentitytypeidorentitytypenameusingpost-1.md): Use this API to create a new entity record.  > 🗒 Things to Know >  > - This API only supports AI Governance entities (Models, Datasets, AI Systems, and AI Agents). > - AI Governance APIs will become available over the course of the Spring as customer tenants are migrated to enhanced AI Governance services. No customer action is required and more detailed information will be published in upcoming release notes and product documentation.
- [Delete Entity](https://developer.onetrust.com/onetrust/reference/deleteusingentitytypeidorentitytypenameusingdelete-1.md): Use this API to delete an existing entity record.  > 🗒 Things to Know >  > - This API only supports AI Governance entities (Models, Datasets, AI Systems, and AI Agents). > - AI Governance APIs will become available over the course of the Spring as customer tenants are migrated to enhanced AI Governance services. No customer action is required and more detailed information will be published in upcoming release notes and product documentation.
- [Get Full Entity Details](https://developer.onetrust.com/onetrust/reference/findallbytypeidandcriteriausingpost-1.md): Use this API to retrieve all the details for the specified entity record by key terms and filters.  > 🗒 Things to Know >  > - This API only supports AI Governance entities (Models, Datasets, AI Systems, and AI Agents). > - AI Governance APIs will become available over the course of the Spring as customer tenants are migrated to enhanced AI Governance services. No customer action is required and more detailed information will be published in upcoming release notes and product documentation.
- [Get Basic Entity Details](https://developer.onetrust.com/onetrust/reference/findentitybasicdetailsbytypeandcriteriausingpost-1.md): Use this API to retrieve basic details for the specified entity record by key terms and filters.  > 🗒 Things to Know >  > - This API only supports AI Governance entities (Models, Datasets, AI Systems, and AI Agents). > - AI Governance APIs will become available over the course of the Spring as customer tenants are migrated to enhanced AI Governance services. No customer action is required and more detailed information will be published in upcoming release notes and product documentation.
- [Get Entity](https://developer.onetrust.com/onetrust/reference/getentityinformationusingentitytypeidorentitytypenameusingget-1.md): Use this API to retrieve a single entity record by its unique identifier along with the associated attributes, module name, and created date.  > 🗒 Things to Know >  > - This API only supports AI Governance entities (Models, Datasets, AI Systems, and AI Agents). > - AI Governance APIs will become available over the course of the Spring as customer tenants are migrated to enhanced AI Governance services. No customer action is required and more detailed information will be published in upcoming release notes and product documentation.
- [Modify Entity](https://developer.onetrust.com/onetrust/reference/updateusingentitytypeidorentitytypenameusingpatch-1.md): Use this API to partially update an existing entity record.  > 🗒 Things to Know >  > - This API only supports AI Governance entities (Models, Datasets, AI Systems, and AI Agents). > - AI Governance APIs will become available over the course of the Spring as customer tenants are migrated to enhanced AI Governance services. No customer action is required and more detailed information will be published in upcoming release notes and product documentation.
- [Get List of Entity Types](https://developer.onetrust.com/onetrust/reference/findallbytypeandcriteriausingpost_1.md): Use this API to retrieve a list of all entity types by key terms and filters.  > 🗒 Things to Know >  > - This API only supports AI Governance entities (Models, Datasets, AI Systems, and AI Agents). > - AI Governance APIs will become available over the course of the Spring as customer tenants are migrated to enhanced AI Governance services. No customer action is required and more detailed information will be published in upcoming release notes and product documentation.
- [Get Entity Type](https://developer.onetrust.com/onetrust/reference/getentitytypeinformationusingget_1-1.md): Use this API to retrieve the details for the specified entity type. The response will return the user who created the entity type, created date, and description.  > 🗒 Things to Know >  > - This API only supports AI Governance entities (Models, Datasets, AI Systems, and AI Agents). > - AI Governance APIs will become available over the course of the Spring as customer tenants are migrated to enhanced AI Governance services. No customer action is required and more detailed information will be published in upcoming release notes and product documentation.
- [Update Entity Workflow Stage](https://developer.onetrust.com/onetrust/reference/assignstagebyname-2.md): Use this API to update the workflow stage for the specified entity record.  > 🗒 Things to Know >  > - This API only supports AI Governance entities (Models, Datasets, AI Systems, and AI Agents). > - AI Governance APIs will become available over the course of the Spring as customer tenants are migrated to enhanced AI Governance services. No customer action is required and more detailed information will be published in upcoming release notes and product documentation.
- [Create Relationship Record between Entities](https://developer.onetrust.com/onetrust/reference/createlinkrecordbetweenentitiesusinglinktypeidusingpost-1.md): Use this API to create a new Relationship Record between entities.  > 🗒 Things to Know >  > - This API only supports AI Governance entities (Models, Datasets, AI Systems, and AI Agents). > - AI Governance APIs will become available over the course of the Spring as customer tenants are migrated to enhanced AI Governance services. No customer action is required and more detailed information will be published in upcoming release notes and product documentation.
- [Remove Relationship Record](https://developer.onetrust.com/onetrust/reference/deletelinkrecordbyidandtypeusinglinktypeidusingdelete-1.md): Use this API to remove an existing Relationship Record between entities.  > 🗒 Things to Know >  > - This API only supports AI Governance entities (Models, Datasets, AI Systems, and AI Agents). > - AI Governance APIs will become available over the course of the Spring as customer tenants are migrated to enhanced AI Governance services. No customer action is required and more detailed information will be published in upcoming release notes and product documentation.
- [Get Relationship Record](https://developer.onetrust.com/onetrust/reference/getlinkrecordinformationusinglinktypeidusingget-1.md): Use this API to retrieve the details of a specific Relationship Record between entities.  > 🗒 Things to Know >  > - This API only supports AI Governance entities (Models, Datasets, AI Systems, and AI Agents). > - AI Governance APIs will become available over the course of the Spring as customer tenants are migrated to enhanced AI Governance services. No customer action is required and more detailed information will be published in upcoming release notes and product documentation.
- [Create Task](https://developer.onetrust.com/onetrust/reference/createtaskusingpost_1-1.md): Use this API to create a new task for an entity.  > 🗒 Things to Know >  > - This API only supports AI Governance entities (Models, Datasets, AI Systems, and AI Agents). > - AI Governance APIs will become available over the course of the Spring as customer tenants are migrated to enhanced AI Governance services. No customer action is required and more detailed information will be published in upcoming release notes and product documentation.
- [Get Task](https://developer.onetrust.com/onetrust/reference/findtaskusingget_1-1.md): Use this API to retrieve a specific task on an entity. The response will include details such as the activity history, assignee, and deadline.  > 🗒 Things to Know >  > - This API only supports AI Governance entities (Models, Datasets, AI Systems, and AI Agents). > - AI Governance APIs will become available over the course of the Spring as customer tenants are migrated to enhanced AI Governance services. No customer action is required and more detailed information will be published in upcoming release notes and product documentation.
- [Update Task](https://developer.onetrust.com/onetrust/reference/updatetaskusingput_1-1.md): Use this API to update an existing task for an entity.  > 🗒 Things to Know >  > - This API only supports AI Governance entities (Models, Datasets, AI Systems, and AI Agents). > - AI Governance APIs will become available over the course of the Spring as customer tenants are migrated to enhanced AI Governance services. No customer action is required and more detailed information will be published in upcoming release notes and product documentation.
- [Creating a New Cookie Runner Script](https://developer.onetrust.com/onetrust/reference/creating-a-new-cookie-runner-script.md)
- [Custom Scan using Worker Node APIs](https://developer.onetrust.com/onetrust/reference/custom-scan-using-worker-node-apis.md)
- [Managing Organizations](https://developer.onetrust.com/onetrust/reference/managing-organizations.md)
- [Managing Users](https://developer.onetrust.com/onetrust/reference/managing-users.md)
- [Updating a User's Role & Organization](https://developer.onetrust.com/onetrust/reference/updating-a-users-role-organization.md)
- [Integrating with Webhooks](https://developer.onetrust.com/onetrust/reference/integrating-with-webhooks.md)
- [Updating a Control Implementation](https://developer.onetrust.com/onetrust/reference/updating-a-control-implementation.md)
- [Updating Risk Details](https://developer.onetrust.com/onetrust/reference/updating-risk-details.md)
- [Importing GDPR Transfer Impact Assessment Template into the OneTrust Application](https://developer.onetrust.com/onetrust/reference/importing-gdpr-transfer-impact-assessment-template-into-onetrust.md)
- [Managing Policies and Notices](https://developer.onetrust.com/onetrust/reference/managing-policies-and-notices.md)
- [Bulk Export Demo Videos](https://developer.onetrust.com/onetrust/reference/bulk-export-demo-videos.md)
- [Embedding the Trust Center on an existing webpage](https://developer.onetrust.com/onetrust/reference/embedding-the-trust-center-on-an-existing-webpage.md)
- [API Use Cases & Best Practices](https://developer.onetrust.com/onetrust/reference/consent-api-use-cases-best-practices.md)
- [API Service Level Objectives](https://developer.onetrust.com/onetrust/reference/consent-preference-management-api-service-level-objectives.md)
- [Enabling iFraming of a OneTrust Preference Center](https://developer.onetrust.com/onetrust/reference/enabling-iframing-of-a-onetrust-preference-center.md)
- [Implementing the Collection Point with REST API](https://developer.onetrust.com/onetrust/reference/implementing-the-collection-point-with-rest-api.md)
- [Introducing the V4 Data Subjects APIs](https://developer.onetrust.com/onetrust/reference/introducing-the-v4-data-subjects-apis.md)
- [Retrieving Client-Side Consent Preferences using the Preferences API](https://developer.onetrust.com/onetrust/reference/retrieving-client-side-consent-preferences-using-the-preferences-api.md)
- [Using Consent Groups to Alter a Data Subject's Consent Status](https://developer.onetrust.com/onetrust/reference/using-consent-groups-to-alter-a-data-subjects-consent-status.md)
- [Using the Preference Center Schema to Build Multi Page Preference Centers](https://developer.onetrust.com/onetrust/reference/using-the-preference-center-schema-to-build-multi-page-preference-centers.md)
- [Using the Preference Center Schema to Build Original or Enhanced Preference Centers](https://developer.onetrust.com/onetrust/reference/using-the-preference-center-schema-to-build-original-or-enhanced-preference-centers.md)
- [V1 to V4 Migration Guide](https://developer.onetrust.com/onetrust/reference/v1-to-v4-migration-guide.md)
- [Welcome to the V4 APIs](https://developer.onetrust.com/onetrust/reference/welcome-to-the-v4-apis.md): The Future of Consent and Preference Management
- [Deprecated APIs List](https://developer.onetrust.com/onetrust/reference/deprecated-apis-list.md): The following endpoints are deprecated or pending deprecatation:
- [OneTrust API Sunsetting & Deprecation Guidelines](https://developer.onetrust.com/onetrust/reference/onetrust-api-sunsetting-deprecation-guidelines.md)
- [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview.md)
- [Supported Languages and HTML Language Codes](https://developer.onetrust.com/onetrust/reference/supported-languages-and-html-language-codes-1.md)
- [System Status](https://developer.onetrust.com/onetrust/reference/system-status.md)
- [Understanding & Implementing Pagination](https://developer.onetrust.com/onetrust/reference/understanding-implementing-pagination.md)
- [Get Data Subject's Preferences](https://developer.onetrust.com/onetrust/reference/getrealtimepreferences.md): Use this API to retrieve a list of all consent preferences for a data subject identifier. The response will include details such as the consent date, purpose preferences, and data subject's geolocation. The response will also include relevant information about data elements and last interaction date, along with the current status of consent for the purposes that the data subject has interacted with.  > 🗒 Things to Know >  > - This API uses a JSON Web Token (JWT) authorization token that will be passed to OneTrust servers to ensure authenticated access to a user's consent profile. This is not the OAuth 2.0 client credential or API key. This JWT authorization token is generated using the cross-device consent process. For more information, see [Cross-Domain and Cross-Device Consent](https://my.onetrust.com/s/article/UUID-750c79df-692c-7418-a395-af2acaa45601). > - This API does not require an intermediary server-server API call. It is optimized for client-side applications, maintaining security to make quick decisions based on data subject consent. > - The response of this API will not return updates made via the [Update Data Subject's Preferences in a Preference Center API](https://developer.onetrust.com/onetrust/reference/updatepreferencesfordatasubjectapiusingput).
- [Get Banner Data](https://developer.onetrust.com/onetrust/reference/get_banner.md): Use this API to retrieve the required interface attributes to be rendered on the Banner.
- [Log Consent](https://developer.onetrust.com/onetrust/reference/post_logconsent.md): Use this API to log consent when a user interacts with a Banner or Preference Center.
- [Get Preference Center Data](https://developer.onetrust.com/onetrust/reference/get_preferences.md): Use this API to retrieve the required interface attributes to be rendered on the Preference Center.
- [Get Universal Consent Purposes](https://developer.onetrust.com/onetrust/reference/get_ucpurposes.md): Use this API to retrieve the required interface attributes to be rendered for Universal Consent Purposes.
- [Get IAB and Google Vendors](https://developer.onetrust.com/onetrust/reference/get_vendors.md): Use this API to retrieve a list of active IAB and Google Vendors to be displayed on the Preference Center.
- [Create Consent Receipts in Bulk](https://developer.onetrust.com/onetrust/reference/createbulkconsentreceiptusingpost.md): Use this API when bulk importing consent receipts. This bulk endpoint optimizes performance when processing a large number of consent transactions simultaneously.  > 🗒 Things to Know >  > - Each collection point must first be set up in the OneTrust Platform to generate a valid JWT, which must be present in the request payload. The JWT can be found on the **Integrations** tab of the **Collection point details** screen or via the [Get Collection Point Token API](https://developer.onetrust.com/onetrust/reference/gettokenusingget). >  > - Response times may vary depending on the number of receipts being processed. Consider implementing appropriate timeout handling in your integration. >  > - In most cases, further authorization is not required. However, additional information for setting up authenticated consent can be found [here](https://my.onetrust.com/s/article/UUID-b359a104-1900-9ac9-7765-ee08c8047f1d) when needed. >  > - OneTrust recommends including no more than 10 purposes per consent receipt, with an absolute maximum of 20 purposes. >  > - The default rate limit for imports is 3k Calls/Minute and 3M Receipts/Day. > > - Please validate all inputs before sending data to a Custom API collection point. This API does not perform data type validation to ensure high performance and fast response times. However, invalid data will not be passed to the data subject.
- [Create Consent Receipts](https://developer.onetrust.com/onetrust/reference/createconsentreceiptusingpost.md): Use this API to create consent receipts from a collection point. This API is used by all collection points and allows external applications to submit requests to store data subject consent transactions.  > 🗒 Things to Know >  > - Each collection point must first be set up in the OneTrust Platform to generate a valid JWT, which must be present in the request payload. The JWT can be found on the **Integrations** tab of the **Collection point details** screen within the platform or can be retrieved by calling the [Get Collection Point Token API](https://developer.onetrust.com/onetrust/reference/gettokenusingget).  >  > - Once the `test` parameter is set to `true`, reverting it to `false` is not possible. However, transitioning from `test=false` to `test=true` is supported. For more information on how to remove the test flag in the OneTrust Platform, see [Managing Data Subject Records](https://my.onetrust.com/s/article/UUID-68370031-bf8a-953e-39a0-5027f766d04f). >  > - In most cases, further authorization is not required. However, additional information for setting up authenticated consent can be found [here](https://my.onetrust.com/s/article/UUID-b359a104-1900-9ac9-7765-ee08c8047f1d) when needed. >  > - Please avoid passing privacy notices for regular Custom API collection points. OneTrust strongly recommends using `privacyNotices` only for those enabled with dynamic configuration, as they allow you to gather information about all purposes. >  > - When passing the `purposes` parameter, the version for `PrivacyNotices` will be used based on the consent date. >  > - OneTrust recommends including no more than 10 purposes per consent receipt, with an absolute maximum of 20 purposes. > > - Please validate all inputs before sending data to a Custom API collection point. This API does not perform data type validation to ensure high performance and fast response times. However, invalid data will not be passed to the data subject.
- [Create Identified Consent Receipts](https://developer.onetrust.com/onetrust/reference/createidentifiedconsentreceiptusingpost.md): Use this API to create consent receipts for identified data subjects using non-cookie collection points. This endpoint is designed specifically for scenarios where data subjects are identified through explicit identifiers rather than cookies.  > 🗒 Things to Know >  > - Each collection point must first be set up in the OneTrust Platform to generate a valid JWT, which must be present in the request payload. The JWT can be found on the **Integrations** tab of the **Collection point details** screen or via the [Get Collection Point Token API](https://developer.onetrust.com/onetrust/reference/gettokenusingget). >  > - When using this endpoint, you must include an identifier for the data subject, such as an email address or other unique identifier, in the request payload. >  > - The identified endpoint creates a persistent record of consent for the data subject that can be managed and updated over time through the OneTrust preference center. >  > - If you need to link multiple identifiers to the same data subject, use the `additionalIdentifiers` parameter in your request payload. >  > - In most cases, further authorization is not required. However, additional information for setting up authenticated consent can be found [here](https://my.onetrust.com/s/article/UUID-b359a104-1900-9ac9-7765-ee08c8047f1d) when needed. >  > - OneTrust recommends including no more than 10 purposes per consent receipt, with an absolute maximum of 20 purposes. > > - Please validate all inputs before sending data to a Custom API collection point. This API does not perform data type validation to ensure high performance and fast response times. However, invalid data will not be passed to the data subject.
- [Categorize Cookies by Domain](https://developer.onetrust.com/onetrust/reference/getcategorizedcookiesusingget.md): Use this API to categorize cookies by cookie name and host for the specified domain. The response will return details for each cookie such as pattern (First-Party or Third-Party) and category (Functional, Strictly Necessary, Targeting, Social Media, or Performance)
- [Categorize Cookies by Domain and Cookie ID](https://developer.onetrust.com/onetrust/reference/getcategorizedcookieswithcookieidsusingget.md): Use this API to categorize cookies by domain and cookie ID. The response will return details for each cookie such as the pattern (First-Party or Third-Party) and the category (Functional, Strictly Necessary, Targeting, Social Media, or Performance).
- [Create Cookie](https://developer.onetrust.com/onetrust/reference/createnewcookie.md): Use this API to create a new cookie.
- [Get List of Cookies by Criteria](https://developer.onetrust.com/onetrust/reference/getcookiereportsusingpost.md): Use this API to retrieve a list of all cookies by filter criteria. > 🗒 Things to Know >  > - If any of the available languages in the OneTrust application is entered as a value for the `language` parameter, cookie categories, descriptions, and third-party descriptions will be translated accordingly.  > - It is recommended to use the `page` and `size` parameters if the number of cookies is greater than 500.
- [Update Cookie](https://developer.onetrust.com/onetrust/reference/updatecookie.md): Use this API to update an existing cookie. > 🗒 Things to Know >  > - There are two types of IDs for cookies: Cookie ID and Domain Cookie ID. The **Cookies Results All Domains** export can be downloaded from the Categorizations screen in the OneTrust application to select the ID for the `cookieId` parameter. > - For manually created cookies, only `cookieName`, `lifespan`, an `host` will be updated. > - Values must be passed in all the parameters within `descriptionTranslations` for a cookie translation to be updated.
- [Create or Update Domain Group](https://developer.onetrust.com/onetrust/reference/createdomaingroupusingpost.md): Use this API to create a new domain group or update an existing domain group.
- [Download Script File](https://developer.onetrust.com/onetrust/reference/downloadtolocalusingget.md): Use this API to download the script files for the specified domain. The files will be downloaded within a folder in blob format.  > 🗒 Things to Know >  > - The domain must be in **Published** status.  > 👍  >  > For more information, see [Downloading and Deploying Scripts from Local Hosting](https://my.onetrust.com/s/article/UUID-3e2923d6-8364-c2fa-0625-7897395f4cd2?topicId=0TO1Q000000ssJBWAY).
- [Get Script for Website](https://developer.onetrust.com/onetrust/reference/getscriptforwebsiteusingget.md): Use this API to retrieve the script for the specified website.
- [Publish Script to Website](https://developer.onetrust.com/onetrust/reference/publishtositeusingput.md): Use this API to publish the script configuration options for the specified website.  > 👍  >  > For more information, see [Publishing and Implementing Cookie Consent Scripts](https://my.onetrust.com/s/article/UUID-7478d3b4-18eb-3ac0-a6fd-fb7ebff9f8dc).
- [Get List of Websites](https://developer.onetrust.com/onetrust/reference/getdomainsscannedbysortusingget.md): Use this API to retrieve a list of all websites in the scanner. The response will return websites in **Pending** and **Completed** status along with the corresponding domain ID, external organization ID, and last scanned date. > 🗒 Things to Know >  > - It is recommended to use the `page` and `size` parameters if the number of domains is greater than 1,000.
- [Add Websites to Scan](https://developer.onetrust.com/onetrust/reference/requestbulkadddomainusingpost.md): Use this API to add a website or multiple websites to the scanner.
- [Create Application](https://developer.onetrust.com/onetrust/reference/createapplication.md): Use this API to create a new application for scan and SDK publishing.
- [Get Branding Attributes for Application](https://developer.onetrust.com/onetrust/reference/getapplicationbrandingattributelist.md): Use this API to retrieve branding attributes for the specified application.
- [Scan Application](https://developer.onetrust.com/onetrust/reference/scanapplication.md): Use this API to initiate an application scan with a file upload.
- [Update Branding Attributes for Application](https://developer.onetrust.com/onetrust/reference/updateapplicationbrandingattributesforpublicapi.md): Use this API to update branding attributes for the specified application.
- [Add Cookies](https://developer.onetrust.com/onetrust/reference/bulkaddcookies.md): Use this API to add cookies.
- [Delete Cookies](https://developer.onetrust.com/onetrust/reference/bulkdeletecookies.md): Use this API to delete cookies by the specified cookie ID or filter criteria.
- [Edit Cookies](https://developer.onetrust.com/onetrust/reference/bulkeditcookies.md): Use this API to edit existing cookies.
- [Get Categorized Cookies](https://developer.onetrust.com/onetrust/reference/getcategorizedcookies.md): Use this API to retrieve categorized cookies by domain.
- [Get List of Cookies by Criteria](https://developer.onetrust.com/onetrust/reference/getcookiesbyfilter.md): Use this API to retrieve a list of cookies by the specified filter criteria.
- [Recategorize Cookies](https://developer.onetrust.com/onetrust/reference/recategorizecookiesbyscan.md): Use this API to initiate cookie recategorization for a scan.
- [Cancel Scheduled Website Scans](https://developer.onetrust.com/onetrust/reference/bulkcanceldomainschedule.md): Use this API to cancel scheduled scans.
- [Create or Update Domain Group](https://developer.onetrust.com/onetrust/reference/createdomaingroup.md): Use this API to create a new domain group or update an existing domain group.
- [Delete Domain](https://developer.onetrust.com/onetrust/reference/deletedomain.md): Use this API to delete the specified domain.
- [Get Branding Attributes for Domain](https://developer.onetrust.com/onetrust/reference/getbrandingattributelist.md): Use this API to retrieve branding attributes for the specified domain.
- [Schedule Website Scans](https://developer.onetrust.com/onetrust/reference/schedulescans.md): Use this API to schedule scans for the specified domains.
- [Update Branding Attributes for Domain](https://developer.onetrust.com/onetrust/reference/updatebrandingattributesforpublicapi.md): Use this API to update branding attributes for the specified domain.
- [Assign Geolocation Rule Group](https://developer.onetrust.com/onetrust/reference/assignentitiestogeorulegroup.md): Use this API to assign or unassign multiple domains and/or applications to a specified geolocation rule group. For each domain or application, set the value to `true` to assign or `false` to unassign.
- [Get Geolocation Rule Group](https://developer.onetrust.com/onetrust/reference/getgeorulegroupdetails.md): Use this API to retrieve detailed information for all geolocation rules within a specified geolocation rule group, including regions, consent model, cookie categories, and other attributes.
- [Get List of Geolocation Rule Groups](https://developer.onetrust.com/onetrust/reference/getgeorulegroups.md): Use this API to retrieve a paginated list of geolocation rule groups. The `search` parameter can be used to optionally filter results by name.
- [Scan Websites](https://developer.onetrust.com/onetrust/reference/addscans.md): Use this API to start scans for the specified domains.
- [Archive Scans](https://developer.onetrust.com/onetrust/reference/archivescans.md): Use this API to archive the specified scans.
- [Cancel Scan](https://developer.onetrust.com/onetrust/reference/cancelscan.md): Use this API to cancel a specific scan.
- [Get Scan Statuses](https://developer.onetrust.com/onetrust/reference/checkscansstatus.md): Use this API to retrieve the status of the specified scans.
- [Get Scan Results](https://developer.onetrust.com/onetrust/reference/getdetailedscanresultinformation.md): Use this API to retrieve results for a specific scan, including details such as cookies, tags, forms, etc.
- [Get List of Scans by Domain](https://developer.onetrust.com/onetrust/reference/getdomainscans.md): Use this API to retrieve a list of scans for a specific domain and the specified filter criteria.
- [Get List of Websites](https://developer.onetrust.com/onetrust/reference/getdomainsscannedbysort.md): Use this API to retrieve a list of websites in the scanner. The response will return websites in Pending and Completed status for the organization and related child organizations.
- [Get List of Added or Removed Cookies](https://developer.onetrust.com/onetrust/reference/getscandeltadetails.md): Use this API to retrieve a list of added or removed cookies between the current and previous scan for the specified domain.
- [Get Scan Result Summary](https://developer.onetrust.com/onetrust/reference/getscanresultsummary.md): Use this API to retrieve summary information for a scan, including counts of cookies, tags, forms, and other entities found.
- [Download Script File](https://developer.onetrust.com/onetrust/reference/downloadscriptfile.md): Use this API to download the script files for the specified domain. The files will be downloaded within a folder in blob format.  > 🗒 Things to Know >  > - The domain must be in **Published** status.  > 👍  >  > For more information, see [Downloading and Deploying Scripts from Local Hosting](https://my.onetrust.com/s/article/UUID-3e2923d6-8364-c2fa-0625-7897395f4cd2).
- [Get Script for Application](https://developer.onetrust.com/onetrust/reference/getappscriptdetails.md): Use this API to retrieve script details for the specified application.
- [Get Script for Domain](https://developer.onetrust.com/onetrust/reference/getscriptdetails.md): Use this API to retrieve script details for the specified website.
- [Get Script for Website](https://developer.onetrust.com/onetrust/reference/getscriptforwebsite.md): Use this API to retrieve the script for the specified website.
- [Publish Application SDK](https://developer.onetrust.com/onetrust/reference/publishappscript.md): Use this API to publish the script configuration options for the specified application.
- [Publish Script to Website](https://developer.onetrust.com/onetrust/reference/publishscripttosite.md): Use this API to publish the script configuration options for the specified website.  > 👍  > > For more information, see [Publishing and Implementing Cookie Consent Scripts](https://my.onetrust.com/s/article/UUID-7478d3b4-18eb-3ac0-a6fd-fb7ebff9f8dc).
- [Get Template Details](https://developer.onetrust.com/onetrust/reference/gettemplatedetails.md): Use this API to retrieve detailed information of a template, including banner setup, preference center setup and the cookie list.
- [Get List of Templates](https://developer.onetrust.com/onetrust/reference/gettemplates.md): Use this API to retrieve a paginated list of templates with their details, including template name, type, current version, and status.
- [Get Domain Data](https://developer.onetrust.com/onetrust/reference/domaindata.md): Use this API to retrieve a list of all templates, cookie consent models, and vendor lists data for the specified domain in JSON format.
- [Get Data Subject's Preferences](https://developer.onetrust.com/onetrust/reference/getpreferencesusingget.md): > ❗️ End of Support Notification > > As of November 23, 2025, this API is now deprecated. Any customers leveraging this API are encouraged to use the [Get Data Subject’s Preferences V2 API](https://developer.onetrust.com/onetrust/reference/getrealtimepreferences). For more information, see [OneTrust API Sunsetting & Deprecation Guidelines](https://developer.onetrust.com/onetrust/reference/onetrust-api-sunsetting-deprecation-guidelines).  Use this API to retrieve a list of all consent preferences for a data subject identifier. The response will include details such as consent date, Purpose Preferences, and data subject's geolocation. The response will also include relevant information about data elements and last interaction date, along with the current status of consent for the purposes that the data subject has interacted with.  > 🗒 Things to Know >  > - This API uses an authorization token with public key model that reduces query response time and bypasses rate limits that are in place with the main APIs that rely on querying the main OneTrust database. > - This API does not require an intermediary server-server API call. It is optimized for client-side applications, maintaining security to make quick decisions based on data subject consent. > - The response of this API will not return updates made via the [Update Data Subject's Preferences in a Preference Center](https://developer.onetrust.com/onetrust/reference/updatepreferencesfordatasubjectapiusingput) API.
- [Get SDK Configuration](https://developer.onetrust.com/onetrust/reference/applicationdata.md): Use this API to retrieve a list of all templates, cookie consent models, and vendor lists data for the specified mobile or OTT application in JSON format. > 🚧  >  > Before calling this API, ensure that the Mobile App data from your OneTrust tenant has been published. For more information, see [Publish Changes](doc:publish-changes).
- [Get List of Privacy Notices](https://developer.onetrust.com/onetrust/reference/getprivacynoticesusingget.md): Use this API to retrieve a list of all privacy notices. The response will include details for each privacy notice along with the corresponding privacy notice ID, created date, and last published date.
- [Get Privacy Notice Version](https://developer.onetrust.com/onetrust/reference/getprivacynoticeversionbypublisheddateusingget.md): Use this API to retrieve a specific version of the privacy notice by the published date and time. The response will return details on the version of the privacy notice that was most recently published before the value specified in the `date` parameter.
- [Get List of Privacy Notice Versions](https://developer.onetrust.com/onetrust/reference/getprivacynoticeversionsusingget.md): Use this API to retrieve a list of versions for a specific privacy notice.
- [Create New Collection Point Version](https://developer.onetrust.com/onetrust/reference/createversionusingpost.md): Use this API to create a new version of an existing Collection Point that is currently in **Active** status. A new version of the Collection Point will be created in **Draft** status while the Active version of the Collection Point will remain unchanged.  > 🗒 Things to Know >  > - Once the Collection Point is in **Draft** status, the Update Existing Collection Point API can be used to edit the Collection Point. Changes will only be visible once the new version of the Collection Point is published.
- [Get List of Collection Points](https://developer.onetrust.com/onetrust/reference/getcollectionpointsusingget_1.md): Use this API to retrieve a list of all Collection Points or retrieve a single Collection Point using the `id` query parameter. By default, the response will return details of all versions of a Collection Point with the Active version listed first, but can be filtered using the `status` query parameter.
- [Create Collection Point](https://developer.onetrust.com/onetrust/reference/createcollectionpointusingpost.md): Use this API to create a new Collection Point. The Collection Point will be created with version **1** and **Draft** status.  > 🗒 Things to Know >  > - Data element name values support up to 750 characters. Data element types containing the word **Country** do not support the following characters: [<>();:'“$#}{] > - If the `EnablePrimaryIdentifier` parameter is set to `true`, then the `PrimaryIdentifierType` parameter will be required in the API request body. > - When creating a Web Form Collection Point, the `HostedSDK` parameter value will be set to `true` by default, regardless of the value entered in the request body. > - One of the following parameters is required in the API request body: `PurposeId`, `PurposeIds`, or `PurposeIdsWithVersion`. > - The `PurposeId` and `PurposeIds` parameters can be used to link an **Active** version of a purpose to a Collection Point. > - The `PurposeIdsWithVersion` parameter can be used to link specific versions of a purpose (either in **Draft** or **Active** status) to a Collection Point.
- [Update Collection Point Status](https://developer.onetrust.com/onetrust/reference/disablecollectionpointusingput.md): Use this API to update the status of a Collection Point.    > 🗒 Things to Know  >   > - To disable the Collection Point, set the `value` query parameter to `true`. All versions of the Collection Point will be disabled from ingesting receipts.  > - To enable the Collection Point, set the `value` query parameter to `false`. The previous status of the Collection Point will be restored.  > - The following Collection Point types cannot be disabled: ADMIN_UPDATE and NOTIFICATION_OPT_OUT.
- [Update Existing Collection Point](https://developer.onetrust.com/onetrust/reference/editcollectionpointusingput.md): Use this API to update an existing Collection Point. Before calling this API, ensure that the Collection Point is in **Draft** status. If the Collection Point is in **Active** status, use the Create New Collection Point Version API to create a new version of the Collection Point.  > 🗒 Things to Know >  > - One of the following parameters must be included in the API request body: `PurposeId`, `PurposeIds`, or `PurposeIdsWithVersion`. > - The `PurposeId` and `PurposeIds` parameters can be used to link an **Active** version of a purpose to a Collection Point. > - The `PurposeIdsWithVersion` parameter can be used to link specific versions of a purpose (either in **Draft** or **Active** status) to a Collection Point.
- [Get List of Collection Points](https://developer.onetrust.com/onetrust/reference/getcollectionpointsusingget.md): Use this API to retrieve a list of all Collection Points. The response will include relevant details for each Collection Point, including purposes, notices, data elements, and more.
- [Get Collection Point Token](https://developer.onetrust.com/onetrust/reference/gettokenusingget.md): Use this API to retrieve the JSON Web Token (JWT) for a given Collection Point. The JWT returned in the response can be used as the `requestInformation` parameter value in the Consent Receipts API in order to pass data subject consent transactions.
- [Download All Consent Attachments](https://developer.onetrust.com/onetrust/reference/downloadconsentattachments.md): Use this API to retrieve all available file references attached to a given data subject. The files will be downloaded in .zip format.
- [Download Consent Attachment](https://developer.onetrust.com/onetrust/reference/downloadgivenconsentattachments.md): Use this API to download a specific file reference attached to a given data subject. The file will be downloaded in .zip format.   > 🗒 Things to Know  >   > - The `attachmentId` parameter value corresponds to the `RefId` parameter value returned after uploading a file using the [Upload Consent Attachment](https://developer.onetrust.com/onetrust/reference/uploadconsentattachments) API.
- [Remove All Consent Attachments](https://developer.onetrust.com/onetrust/reference/removeallconsentattachmentrefs.md): Use this API to remove all file references attached to a given data subject.
- [Remove Consent Attachment](https://developer.onetrust.com/onetrust/reference/removegivenconsentattachmentrefs.md): Use this API to remove a specific file reference attached to a given data subject.  > 🗒 Things to Know >  > - The `attachmentId` parameter value corresponds to the `RefId` parameter value returned after uploading a file using the [Upload Attachments](https://developer.onetrust.com/onetrust/reference/uploadconsentattachments) API.
- [Upload Consent Attachment](https://developer.onetrust.com/onetrust/reference/uploadconsentattachments.md): Use this API to upload and store files which contain written consent of data subjects' transactions.  > 🗒 Things to Know >  > - The size of uploaded files must be less than 4MB. >  > - The following file formats are allowed: .pdf, .jpeg, .jpg, and .png. >  > - The `RefID` parameter returned within the response body can be used to attach file references to incoming data subject consents using the [Create Consent Receipts](https://developer.onetrust.com/onetrust/reference/createconsentreceiptusingpost) API. >  > - File references can be attached to a given data subject or data subject purpose by using the `attachments` or `PurposeAttachments` parameters in the [Create Consent Receipts](https://developer.onetrust.com/onetrust/reference/createconsentreceiptusingpost) API respectively.
- [Add Consent Groups to Parent Consent Group](https://developer.onetrust.com/onetrust/reference/addconsentgroupstoconsentgroupusingpost.md): Use this API to add Consent Groups as children of the specified Parent Consent Group.  > 🗒 Things to Know >  > - A Consent Group can only be added as a child to one Parent Consent Group. > - A Parent Consent Group can either have Consent Groups as children or data subjects as children within a given level in the hierarchy, not both. If Consent Groups are added as children to the Parent Consent Group, data subjects cannot be added to the Parent Consent Group at that given level. > - Consent Groups can support a hierarchical structure of up to 4 levels. However, once data subjects are added as children to a Parent Consent Group, no additional Consent Groups can be added to that hierarchical structure.
- [Add Data Subjects to Parent Consent Group](https://developer.onetrust.com/onetrust/reference/adddatasubjectstoconsentgroupusingpost.md): Use this API to add data subjects as children of the specified Parent Consent Group.  > 🗒 Things to Know >  > - A Parent Consent Group can either have Consent Groups as children or data subjects as children within a given level in the hierarchy, not both. If data subjects are added as children to the Parent Consent Group, Consent Groups cannot be added to the Parent Consent Group at that given level or any level below in the hierarchical structure.
- [Add Purpose Rules to Consent Group](https://developer.onetrust.com/onetrust/reference/addpurposerulestoconsentgroupusingpost.md): Use this API to add Purpose Rules to a Consent Group. These rules will dictate which Purposes will be overridden with the defined Enforced Status for data subjects within the given Consent Group.  > 🗒 Things to Know >  > - Each Purpose in a Consent Group has its own Purpose Rule which is comprised of an Enforced Status and Effective Status. > - The Enforced Status is the Purpose Status that you want to apply for a particular Purpose. > - The Effective Status is calculated using the Priority Scores across the entire Consent Group hierarchy for each Purpose.
- [Create Consent Group](https://developer.onetrust.com/onetrust/reference/createconsentgroupusingpost.md): Use this API to create a new Consent Group by providing a name, description, and optional external name.  > 🗒 Things to Know >  > - If an external name is not defined, one will be generated automatically.
- [Remove Purpose Rule from Consent Group](https://developer.onetrust.com/onetrust/reference/deleteconsentgrouppurposeruleusingdelete.md): Use this API to remove existing Purpose Rules from a Consent Group.
- [Remove Data Subject from Parent Consent Group](https://developer.onetrust.com/onetrust/reference/deletedatasubjectstoconsentgroupusingdelete.md): Use this API to remove a single data subject as a child of the specified Parent Consent Group.  > 🗒 Things to Know >  > - Only one data subject can be removed per API call.
- [Get List of Consent Groups](https://developer.onetrust.com/onetrust/reference/getconsentgrouplistusingget.md): Use this API to retrieve a list of all Consent Groups along with details such as the Consent Group ID, associated Purpose Rules, and the list of data subjects and/or Consent Groups within its hierarchal structure.
- [Get Priority Scores for Purpose Statuses](https://developer.onetrust.com/onetrust/reference/getconsentgroupsettingsusingget.md): Use this API to retrieve the Priority Scores for each Purpose Status.  > 🗒 Things to Know >  > - All Purpose Statuses are given a Priority Score. A Purpose Status with a lower Priority Score will be given precedence over a Purpose Status with a higher Priority Score. > - Each Purpose in a Consent Group has its own Purpose Rule which is comprised of an Enforced Status and Effective Status. > - The Enforced Status is the Purpose Status that you want to apply for a particular Purpose. > - The Effective Status is calculated using the Priority Scores across the entire Consent Group hierarchy for each Purpose.  > 👍  >  > For more information, see [Using Consent Groups to Alter a Data Subject's Consent Status](https://developer.onetrust.com/onetrust/docs/using-consent-groups-to-alter-a-data-subjects-consent-status).
- [Get Consent Group](https://developer.onetrust.com/onetrust/reference/getconsentgroupusingget.md): Use this API to retrieve a single Consent Group by its unique identifier along with details such as the Consent Group ID, associated Purpose Rules, and the list of data subjects and/or Consent Groups within its hierarchal structure.
- [Remove Consent Groups from Parent Consent Group](https://developer.onetrust.com/onetrust/reference/unlinkconsentgroupusingdelete.md): Use this API to remove Consent Groups as children of the specified Parent Consent Group.  > 🗒 Things to Know >  > - Multiple Consent Groups can be removed within the same API call by specifying the list of child Consent Group IDs.
- [Update Priority Scores for Purpose Statuses](https://developer.onetrust.com/onetrust/reference/updateconsentgroupsettingsusingput.md): Use this API to update the current Priority Score values for the Purpose Statuses. Priority Scores across the entire Consent Group hierarchy are used to calculate the Effective Status of a Purpose.  > 🗒 Things to Know >  > - All Purpose Statuses are given a Priority Score. A Purpose Status with a lower Priority Score will be given precedence over a Purpose Status with a higher Priority Score. Any new Purpose Statuses will automatically be given a higher priority score by default. > - When calculating the Effective Status of any Purpose in a Consent Group: > - If there is no Parent Consent Group, the Effective Status becomes the same as the Enforced Status. > - If there is a Parent Consent Group, the Effective Status would be calculated by comparing the Priority Score of the Enforced Status of the Purpose at that hierarchy level with the Priority Score of the Effective Status of the Purpose in the Parent level and applying the status associated with the lower Priority Score.  > 👍  >  > For more information, see [Using Consent Groups to Alter a Data Subject's Consent Status](https://developer.onetrust.com/onetrust/docs/using-consent-groups-to-alter-a-data-subjects-consent-status).
- [Update Consent Group Purpose Rule](https://developer.onetrust.com/onetrust/reference/updatepurposerulestoconsentgroupusingput.md): Use this API to update existing Purpose Rules within a Consent Group.
- [Delete Cross Device Consents and Receipts](https://developer.onetrust.com/onetrust/reference/crossdeviceconsentusingdelete.md): Use this API to delete cross device consents and the related receipts. This API is designed for users with a CRO license. However, users with both UCPM and CRO licenses, can use the [Delete Data Subjects](https://developer.onetrust.com/onetrust/reference/deletedatasubjectprofileusingdelete) API to delete CRO data subject identifiers.  > 🗒 Things to Know >  > - A maximum of 1000 data subject identifiers can be deleted per request.  > - Requests will be processed asynchronously.
- [Create Data Subject Group](https://developer.onetrust.com/onetrust/reference/createdatasubjectgroupv4.md): Use this API to create a new Data Subject Group.  > 🗒 Things to Know > > - Data Subject Groups must contain at least one primary data subject identifier and two data subjects.
- [Get List of Data Subject Groups](https://developer.onetrust.com/onetrust/reference/getdatasubjectgroupslistv4.md): Use this API to retrieve a list of Data Subject Groups.
- [Get List of Data Subject Group Members](https://developer.onetrust.com/onetrust/reference/getlinkedidentitygroupmembersv4.md): Use this API to retrieve a list of all members of a data subject group.
- [Get List of Data Subject Group Associations by Data Subject](https://developer.onetrust.com/onetrust/reference/getlinkedidentitygroupsbydatasubjectv4.md): Use this API to retrieve details about a data subject's associations with Data Subject Groups.  > 🗒 Things to Know >  > - If the `linkedIdentityGroupId` parameter is passed, the response will include details for the data subject's association with the specified Data Subject Group. If not passed, the response will include details for the data subject's associations with all Data Subject Groups in which the data subject is a member.
- [Update Data Subject Group](https://developer.onetrust.com/onetrust/reference/updatedatasubjectgroupv4.md): Use this API to update an existing Data Subject Group.  > 🗒 Things to Know > > - Data Subject Groups must contain at least one primary data subject identifier and two data subjects. > - To update the Data Subject Group name, use the `groupName` parameter and enter a new name different from the one already in use.
- [Create Data Subject Group](https://developer.onetrust.com/onetrust/reference/createlinkedidentitygroupusingpost.md): Use this API to create a new Data Subject Group.  > 🗒 Things to Know >  > - Data Subject Groups must contain at least one primary data subject identifier and two data subjects.
- [Delete Data Subject Group](https://developer.onetrust.com/onetrust/reference/deleteusingdelete.md): Use this API to delete an existing Data Subject Group.
- [Get List of Data Subject Groups](https://developer.onetrust.com/onetrust/reference/getlinkedidentitygroupsusingget.md): Use this API to retrieve a list of all Data Subject Groups. The response will include the Data Subject Group ID, number of data subjects, and details of the primary data subjects in the group.
- [Get Data Subject Group](https://developer.onetrust.com/onetrust/reference/getlinkedidentitygroupusingget.md): Use this API to retrieve a single Data Subject Group by its unique identifier along with details such as the Data Subject Group ID and the list of data subjects within its group.
- [Update Data Subject Group](https://developer.onetrust.com/onetrust/reference/updatelinkedidentitygroupusingput.md): Use this API to update an existing Data Subject Group.  > 🗒 Things to Know >  > - Data Subject Groups must contain at least one primary data subject identifier and two data subjects. > - To update the Data Subject Group name, use the `groupName` parameter and enter a new name different from the one already in use.
- [Delete Purposes from Data Subject](https://developer.onetrust.com/onetrust/reference/deletedatasubjectprofilesusingdelete.md): Use this API to delete up to 100 purposes from one data subject or to delete one purpose from up to 100 data subjects.  > 🗒 Things to Know >  > - By default, related data subject transactions will be removed from the database and will no longer appear in the OneTrust Platform UI after calling this API. However, the transactions can still be retrieved using the [Get List of Receipts API](https://developer.onetrust.com/onetrust/reference/getreceiptlistdetailsusingpost). To maintain data subject transactions in the database and OneTrust Platform UI, set the `retainTransactions` parameter to `true`.
- [Delete Data Subjects](https://developer.onetrust.com/onetrust/reference/deletedatasubjectprofileusingdelete.md): Use this API to delete data subjects. Deleting data subjects is a permanent action that should be exercised with caution.  > 🗒 Things to Know >  > - Data subjects can be deleted using any of the following values at a time: >      - List of Identifiers >      - List of Data Subject Identifier GUIDs >      - Date range between `fromCreatedDate` and `toCreatedDate` (the timespan must be 24 hours or less). >      - Date range between `fromInteractionDate` and `toInteractionDate` (the timespan must be 24 hours or less). > - When filtering by date range, created date and interaction date should be used separately. They should not be used at the same time. > - Up to 999 data subject identifiers can be deleted per API call. > - If a new data subject has to be deleted, it is recommended to wait at least 24 hours after its creation to ensure that all the data has been properly stored and synchronized before removal. > - Requests will be processed asynchronously and can be monitored in the View Activity option in the Data Subject list view within the OneTrust Platform. If multiple calls are required, wait until each request processes before making another call. > - By default, related data subject receipts and transactions will be removed from the database and will no longer appear in the OneTrust Platform UI after calling this API. However, the receipts and transactions can still be retrieved using the [Get List of Receipts API](https://developer.onetrust.com/onetrust/reference/getreceiptlistdetailsusingpost). To maintain data subject receipts and transactions in the database and OneTrust Platform UI, set the `retainReceiptsTransactions` parameter to `true`.  > 👍  >  > The **Enable Data Subject Deletion** setting must be enabled within Global Settings in the OneTrust application in order to use this API. For more information, see [Deleting Data Subject Records](https://my.onetrust.com/s/article/UUID-73ac74f6-edc7-3344-e86e-e810660154e9?topicId=0TO1Q000000ItSSWA0).
- [Delete Purpose from Data Subjects](https://developer.onetrust.com/onetrust/reference/deletepurposefromdatasubjectusingdelete.md): Use this API for large scale deletion of a specific purpose from all data subjects.  > 🗒 Things to Know >  > - A data subject exclusion list is required to provide the specific data subjects from which the purpose should not be deleted. The **Consent DS Exclusion** import template within Global Settings in the OneTrust Platform can be used to create the data subject exclusion list and can be imported via Bulk Import in the application or via API. > - Once the data subject exclusion list has been successfully imported, either an `importID` or `jobGuid` parameter value must be specified in the request body. > - Data subject exclusion lists are valid during the next 30 days after submission. > - To override the data subject exclusion list requirement, set the `deletePurposeFromAllDataSubjects` parameter value to `true`. By default, this parameter is set to `false`. > - By default, related data subject transactions will be removed from the database and will no longer appear in the OneTrust Platform UI after calling this API. However, the transactions can still be retrieved using the [Get List of Receipts API](https://developer.onetrust.com/onetrust/reference/getreceiptlistdetailsusingpost). To maintain data subject transactions in the database and OneTrust Platform UI, set the `retainTransactions` parameter to `true`.
- [Get List of Data Subjects](https://developer.onetrust.com/onetrust/reference/getdatasubjectsusingget.md): Use this API to retrieve a list of all data subjects. The response will include details for each data subject such as the associated data elements, data subject ID, and data subject identifier. By default, the response will return data subject details sorted in descending order of last modified date.  > 🗒 Things to Know >  > - This API is not designed to be used in synchronous workflows. As an alternative, the [Gets preferences for a Data Subject](https://developer.onetrust.com/onetrust/reference/getpreferencesusingget) API can be called.  > 🚧  >  > Please note that the FTC Do Not Call List is updated once daily and not updated in real time. As such, there may be a possibility that a consumer's preferences may have changed and they may have opted out of receiving communication before the Do Not Call list gets refreshed. OneTrust is merely conveying information received from the FTC and is not responsible for compiling the lists.
- [Search Data Subjects](https://developer.onetrust.com/onetrust/reference/searchdatasubjectspostusingpost.md): Use this API to search for data subjects based on various criteria. The response will include details for each matching data subject such as the associated data elements, data subject ID, and data subject identifier.  > 🗒 Things to Know >  > - This API supports complex search criteria including filtering by data elements, purposes, and consent status. > - For large result sets, use pagination to retrieve data in manageable chunks. > - The response can be customized using the properties parameter to include or exclude certain data.  > 🚧  >  > Please note that the FTC Do Not Call List is updated once daily and not updated in real time. As such, there may be a possibility that a consumer's preferences may have changed and they may have opted out of receiving communication before the Do Not Call list gets refreshed. OneTrust is merely conveying information received from the FTC and is not responsible for compiling the lists.
- [Get List of Data Subjects](https://developer.onetrust.com/onetrust/reference/getv3datasubjectprofilesusingpost.md): > ❗️ Migration Recommendation >  > Please, do not adopt this API if you have not already done so. Continue to use the [Get List of Data Subjects](https://developer.onetrust.com/onetrust/reference/getdatasubjectprofileusingget) V1 API or request access to have Data Subjects V4 APIs enabled.  Use this API to retrieve a list of all data subjects. Depending on the query or header parameter values passed in the request, the response will return specific details about data subjects, including relevant information about the latest Collection Point update.  > 🗒 Things to Know >  > - This API can also be used to retrieve the magic link token as `linkToken` in the response. >  > - The `identifier` header parameter can be used to return information for a single data subject. >  > - This API is designed to remain available during maintenance periods. > > - This API is not designed to be used in workflows.
- [Get Data Subject](https://developer.onetrust.com/onetrust/reference/getv3datasubjectsprofileusingget.md): > ❗️ Migration Recommendation >  > Please, do not adopt this API if you have not already done so. Continue to use the [Get List of Data Subjects](https://developer.onetrust.com/onetrust/reference/getdatasubjectprofileusingget) V1 API or request access to have Data Subjects V4 APIs enabled.  Use this API to retrieve a single data subject using the `identifer` header parameter.  > 🗒 Things to Know >  > - This API can also be used to retrieve the magic link token as `linkToken` in the response. > - This API will remain available during maintenance periods. > - This API is not designed to be used in workflows.
- [Delete Data Subject](https://developer.onetrust.com/onetrust/reference/deletedatasubjectusingttl.md): Initiates a TTL-based deletion process for a data subject
- [Delete Purposes from Data Subject](https://developer.onetrust.com/onetrust/reference/deletepurposefromdatasubjectsusingttl.md): Initiates TTL-based deletion of specific purposes from data subjects
- [Get List of All Purpose Details by Data Subject](https://developer.onetrust.com/onetrust/reference/getallprofilesbydatasubjectv4.md): Use this API to retrieve a data subject’s purpose details for all purposes. The response will include all purposes that the data subject interacted with along with details such as status, last transaction date, consent date, and purpose preferences.
- [Get Data Subject](https://developer.onetrust.com/onetrust/reference/getdatasubjectbasicdetailsv4.md): Use this API to retrieve a data subject’s basic details. The response will include details such as the data subject’s created date, last transaction date, and data elements.
- [Get Data Subject Details](https://developer.onetrust.com/onetrust/reference/getdatasubjectdetailsv4.md): Use this API to retrieve complete details for a specific data subject. The response will include all of the data subject’s basic details, purpose details, and email link tokens.
- [Get Optimized List of All Purpose Details for All Data Subjects](https://developer.onetrust.com/onetrust/reference/getdatasubjectprofilesunorderedv4.md): Use this optimized for high-performance API to retrieve an unsorted list of purpose details last updated between the specified date range for all data subjects.  > 🗒 Things to Know > > - The maximum date range that can be returned is 7 days.   > - Results are not returned in a specific order and may appear random.   > - Supports bookmarking for consistent pagination.   > - Optimized for high-performance bulk retrieval where sorting is not required.   > - Has more flexible rate limits compared to the standard [Get List of All Purpose Details for All Data Subjects](/onetrust/reference/getdatasubjectprofilesv4) API.
- [Get List of All Purpose Details for All Data Subjects](https://developer.onetrust.com/onetrust/reference/getdatasubjectprofilesv4.md): Use this API to retrieve a list of all purpose details last updated between a specified date range for all data subjects.  > 🗒 Things to Know >  > - The maximum date range that can be returned is 7 days.
- [Get Purpose Details by Data Subject](https://developer.onetrust.com/onetrust/reference/getdatasubjectprofilev4.md): Use this API to retrieve a data subject’s purpose details for a specific purpose. The response will include details such as the last transaction date, consent date, and purpose preferences.
- [Get Optimized List of Data Subjects](https://developer.onetrust.com/onetrust/reference/getdatasubjectsunorderedv4.md): Use this optimized for high-performance API to retrieve a list of unsorted data subjects that were last updated between the specified date range. The response includes key details such as each data subject’s identifier, created date, data elements, and last updated date.  > 🗒 Things to Know > > - The maximum date range that can be returned is 7 days.   > - Results are not returned in a specific order and may appear random.   > - Supports bookmarking for consistent pagination.   > - Optimized for high-performance bulk retrieval where sorting is not required.   > - Has more flexible rate limits compared to the standard [Get List of Data Subjects](/onetrust/reference/getdatasubjectsv4) API.
- [Get List of Data Subjects](https://developer.onetrust.com/onetrust/reference/getdatasubjectsv4.md): Use this API to retrieve a list of data subjects that were last updated between the specified date range. The response will include basic details, such as each data subject’s identifier, created date, data elements, and last updated date.  > 🗒 Things to Know >  > - The maximum date range that can be returned is 7 days.
- [Update Data Subject's Data Elements](https://developer.onetrust.com/onetrust/reference/createorupdatedatasubjectusingpost.md): Use this API to create a new data subject or update an existing data subject. The data subject will be created or updated with the details provided in the request body.  > 🗒 Things to Know >  > - The data subject primary identifier cannot be updated. However, additional identifiers can be added, updated, or deleted: >   - To add or update an additional identifier for a given data subject, set the `linked` parameter value to `true` and include a list of the additional identifiers within the `value` parameter. >   - To remove an additional identifier from a given data subject, set the `linked` parameter value to `true` and leave the `value` parameter empty. Removed identifiers will remain associated with the data subject as data elements. > - This API is not designed to be used in synchronous workflows and will not trigger integration events or reporting updates.  Below are templated examples of adding, editing, and deleting additional identifiers for the data subject.  ```json Add {   "dataElements": [     {       "name": "ADDITIONAL_IDENTIFIER_TYPE", // For example: Email       "linked": true, // When dealing with identifiers, set this value to true       "value": ["EXISTING IDENTIFIER", "NEW_IDENTIFIER"] // Make sure to keep the existing identifier if you already have one for that type     }   ] } ``` ```json Edit {   "dataElements": [     {       "name": "ADDITIONAL_IDENTIFIER_TYPE", // For example: Email       "linked": true, // When dealing with identifiers, set this value to true       "value": ["EDITED IDENTIFIER"] // Make sure to keep the existing identifier if you already have one for that type     }   ] } ``` ```json Delete {   "dataElements": [     {       "name": "ADDITIONAL_IDENTIFIER_TYPE", // For example: Email       "linked": true, // When dealing with identifiers, set this value to true       "value": [] // Keep empty if you want to remove all additional identifiers that share the identifier type     }   ] } ```
- [Get List of Data Subjects](https://developer.onetrust.com/onetrust/reference/getdatasubjectprofileusingget.md): Use this API to retrieve a list of all data subjects. The response will include details for each data subject such as data elements, purposes, associated topics, and purpose preferences. The response will also include relevant information about the latest Collection Point interactions and receipt IDs, along with the current status of consent for the purposes and preferences they have interacted with.  > 🗒 Things to Know >  > - It is critical that all queries include `properties=ignoreCount`. Not including `ignoreCount` will significantly decrease performance. If you need the count, we advise to only include it in the initial query, and not for subsequent page calls. > - The values passed in the `properties` query parameter can change the response of this API. A fast response on large data sets can be obtained passing any of the following values: `linkTokens`, `ignoreCount`, `ignoreTopics`, `ignoreCustomPreferences`. > - This API is not designed to be used in synchronous workflows. As an alternative, the [Gets preferences for a Data Subject](https://developer.onetrust.com/onetrust/reference/getpreferencesusingget) API can be called. > - It is strongly recommended to pass the `requestContinuation` parameter returned in the response of this API in the next API request to paginate. Including it is crucial for better performance when dealing with multiple pages of data subject records. For more information, see [Understanding & Implementing Pagination](https://developer.onetrust.com/onetrust/reference/understanding-implementing-pagination). > - When specifying a data subject identifier, only the primary identifier is supported. Additional identifiers cannot be used for search or filtering.  > 🚧  >  > Please note that the FTC Do Not Call List is updated once daily and not updated in real time. As such, there may be a possibility that a consumer's preferences may have changed and they may have opted out of receiving communication before the Do Not Call list gets refreshed. OneTrust is merely conveying information received from the FTC and is not responsible for compiling the lists.
- [Get List of Purposes for a Data Subject](https://developer.onetrust.com/onetrust/reference/getdatasubjectpurposesbyidentifierusingget.md): Gets a paged list of Purposes for a Data Subject identifier. We strongly suggest using GET [/datasubjects/profiles](https://developer.onetrust.com/onetrust/reference/getdatasubjectprofileusingget) instead, as this endpoint has been deprecated.
- [Deduplicate Data Subjects](https://developer.onetrust.com/onetrust/reference/mergedatasubjectsusingpost.md): Use this API to merge data subject records into a primary data subject record. The transactions and profile history captured across multiple data subject identifiers will be consolidated into the primary data subject record, containing all of the data subject's information.  > 🗒 Things to Know >  > - Data subjects indicated in the `additionalIdentifiers` parameter value will be deleted after being merged with the `primaryIdentifier`. > - Existing transactions for the `additionalIdentifiers` value will convert to the `primaryIdentifier`. > - Data elements will use the most recent updated value across all of the data subject identifiers. > - Receipts will remain under the data subject identifier from which they were generated. > - Data subjects merged into a single profile will use the magic link of the remaining data subject. > - Merging data subjects may affect the primary data subject's consent status. For more information about transaction and status logic, see [Universal Consent & Preference Management Transaction Types and Purpose Statuses](https://my.onetrust.com/s/article/UUID-d4ed05a9-a999-f2cb-8272-610a5817b43f).
- [Delete Scheduled Export](https://developer.onetrust.com/onetrust/reference/deletemergerequestusingdelete.md): Use this API to delete a scheduled export of duplicate data subjects.
- [Generate Export of Duplicate Data Subjects](https://developer.onetrust.com/onetrust/reference/exportduplicatedatasubject.md): Use this API to generate an export of duplicate data subjects. Once generated, the Duplicate Data Subjects export will be sent to the user specified in the request as an .xlsx file and can be downloaded from the OneTrust application.  > 🗒 Things to Know >  > - The [Create Scheduled Export](https://developer.onetrust.com/onetrust/reference/schedulemergerequestusingpost) API can be used to create scheduled exports of duplicate data subjects. > - The [Merge Duplicate Data Subjects](https://developer.onetrust.com/onetrust/reference/mergedatasubjectusingpost) API can be used if data subjects should be merged upon review of the export.
- [Get Scheduled Export](https://developer.onetrust.com/onetrust/reference/getmergerequestusingget.md): Use this API to retrieve details of a specific scheduled export of duplicate data subjects. The response will include the associated merge request name, export frequency, and export status.
- [Get List of Scheduled Exports](https://developer.onetrust.com/onetrust/reference/getpagedmergerequestusingget.md): Use this API to retrieve a list of all scheduled exports of duplicate data subjects. The response will include the merge request ID along with the associated merge request name, export frequency, and export status.
- [Deduplicate Data Subjects](https://developer.onetrust.com/onetrust/reference/mergedatasubjectusingpost.md): Use this API to merge duplicate data subjects in order to consolidate existing Purpose statuses captured across the different identifiers into a single data subject profile.  > 🗒 Things to Know >  > - The [Create Scheduled Export](https://developer.onetrust.com/onetrust/reference/schedulemergerequestusingpost) API can be used to create scheduled exports of duplicate data subjects. > - The [Generate Export of Duplicate Data Subjects](https://developer.onetrust.com/onetrust/reference/exportduplicatedatasubject) API can be used to generate exports that identify duplicate data subjects.  > 👍  >  > For more information, see [Merging Data Subjects](https://my.onetrust.com/s/article/UUID-87184a50-16e5-185a-36c2-2ca0b2e18372).
- [Create Scheduled Export of Duplicate Data Subjects](https://developer.onetrust.com/onetrust/reference/schedulemergerequestusingpost.md): Use this API to create a scheduled export of duplicate data subjects.  > 🗒 Things to Know >  > - Once the scheduled export is created, you can retrieve the file using the [Generate Export of Duplicate Data Subjects](https://developer.onetrust.com/onetrust/reference/exportduplicatedatasubject) API.
- [Get List of Deletion Certificates](https://developer.onetrust.com/onetrust/reference/getlistofdeletioncertificates.md): Use this API to retrieve a paginated list of deletion certificates. Each result contains information about a data subject or receipts deletion certificate. Supports continuation tokens for pagination.
- [Create Job](https://developer.onetrust.com/onetrust/reference/createjobusingpost-1.md): Use this API to create a new schedule job for data subject bulk actions.
- [Get Data Subject Token](https://developer.onetrust.com/onetrust/reference/getemaillinktokenbydatasubjectv4.md): Use this API to retrieve the link token for a specific data subject.
- [Get List of Data Subject Tokens](https://developer.onetrust.com/onetrust/reference/getemaillinktokenslistv4.md): Use this API to retrieve a list of link tokens created between a specified date range for all data subjects.  > 🗒 Things to Know >  > - The maximum date range that can be returned is 7 days.
- [Get List of Data Subject Tokens](https://developer.onetrust.com/onetrust/reference/getlinktokensusingget.md): Use this API to retrieve a list of link tokens. The response will return link tokens along with the corresponding data subject ID, created date, and expiry date. By default, the response will return link token details sorted in ascending order of created date.
- [Get Preference Center Page Schema](https://developer.onetrust.com/onetrust/reference/getpreferencecenterpageschemausingget.md): Use this API to retrieve the schema for a specific page within a Multi Page Preference Center. The response will include the structure of the specified page within the Preference Center, including the sections, Purposes, and Data Elements.
- [Get List of Preference Centers](https://developer.onetrust.com/onetrust/reference/getpreferencecentersusingget.md): Use this API to retrieve a list of all Preference Centers. The response will include details for each Preference Center along with the corresponding Preference Center ID, created date, and published date.
- [Get Preference Center Root Schema](https://developer.onetrust.com/onetrust/reference/getrootschemausingget.md): Use this API to retrieve the root schema for a Multi Page Preference Center. The response will include the root structure of the Preference Center, including the settings, languages, and configured pages.
- [Get Data Subject's Preferences in a Preference Center](https://developer.onetrust.com/onetrust/reference/getdatasubjectpurposesbyidentifierusingget_1.md): Use this API to retrieve a data subject's preferences within a Preference Center. The response will include the list of Purposes that the data subject interacted with in the specified Preference Center along with their current status.
- [Get Preference Center Schema](https://developer.onetrust.com/onetrust/reference/getpreferencecenterbyidusingget.md): Use this API to retrieve the schema of a Preference Center. The response will include details about the Preference Center such as settings, languages, and Purposes.  > 🗒 Things to Know >  > - This API can be used for Original, Enhanced, and Multi Page Preference Centers.
- [Update Data Subject's Preferences in a Preference Center](https://developer.onetrust.com/onetrust/reference/updatepreferencesfordatasubjectapiusingput.md): Use this API to update the data subject's preferences within a Preference Center.  > 🗒 Things to Know >  > - Pascal case is required for all parameters. For example, use `DsDataElements` instead of `dsDataElements`.
- [Withdraw Data Subject's Consent for All Purposes in a Preference Center](https://developer.onetrust.com/onetrust/reference/withdrawpreferencesapiusingdelete.md): Use this API to withdraw a data subject's consent for all Purposes within a Preference Center.  > 🗒 Things to Know >  > - The Notification Opt-Out Purpose will be excluded when calling this API.
- [Create Purpose Preference](https://developer.onetrust.com/onetrust/reference/createcustompreferenceusingpost.md): Use this API to create a new Purpose Preference. The Purpose Preference will be created with the details provided in the request body.
- [Update Purpose Preference](https://developer.onetrust.com/onetrust/reference/editcustompreferenceusingput.md): Use this API to edit a specific Purpose Preference. The Purpose Preference will be updated with the details provided in the request body.
- [Get Purpose Preference](https://developer.onetrust.com/onetrust/reference/findbyguidusingget.md): Use this API to retrieve a single Purpose Preference by its unique identifier along with details such as the Purpose Preference name, languages, number of options, created date, and updated date.
- [Get List of Purpose Preferences](https://developer.onetrust.com/onetrust/reference/getlistusingget.md): Use this API to retrieve a list of all Purpose Preferences. The response will include basic details such as the Purpose Preference name, languages, number of options, created date, and updated date.
- [Get List of Purpose Versions](https://developer.onetrust.com/onetrust/reference/getgroupedpurposesv2.md): Use this API to retrieve a list of Purpose versions. The response will include details for each Purpose version along with the corresponding Purpose ID, created date, and published date.  > 🗒 Things to Know >  > - This API returns Purpose descriptions inside `<p>` and `</p> `HTML tags. These can be sanitized depending on your formatting needs.
- [Get Purpose](https://developer.onetrust.com/onetrust/reference/getpurposedetailusingget.md): Use this API to retrieve a single Purpose by its unique identifier along with the associated attributes, Purpose Preferences, and created date.  > 🗒 Things to Know >  > - This API returns Purpose descriptions inside `<p>` and `</p> `HTML tags. These can be sanitized depending on your formatting needs.
- [Create New Purpose Version](https://developer.onetrust.com/onetrust/reference/createnewpurposeversionusingpost.md): Use this API to create a new version of an existing Purpose that is currently in **Active** status. A new version of the Purpose will be created in **Draft** status while the **Active** version of the Purpose will remain unchanged.  > 🗒 Things to Know >  > - Once the Purpose is in **Draft** status, the [Update Purpose](https://developer.onetrust.com/onetrust/reference/editpurposeusingput) API can be used to edit the Purpose. Changes will only be visible once the new version of the Purpose is published. > - This API returns Purpose descriptions inside `<p>` and `</p> `HTML tags. These can be sanitized depending on your formatting needs.
- [Create Purpose](https://developer.onetrust.com/onetrust/reference/createpurposeusingpost.md): Use this this API to create a new Purpose. The new Purpose will be created in **Draft** status and version **1**.  > 🗒 Things to Know >  > - This API returns Purpose descriptions inside `<p>` and `</p> `HTML tags. These can be sanitized depending on your formatting needs.
- [Update Purpose](https://developer.onetrust.com/onetrust/reference/editpurposeusingput.md): Use this API to update an existing Purpose. Before calling this API, ensure that the Purpose is in **Draft** status. If the Purpose is in **Active** status, use the [Create New Purpose Version](https://developer.onetrust.com/onetrust/reference/createnewpurposeversionusingpost) API to create a new version of the Purpose.  > 🗒 Things to Know >  > - This API returns Purpose descriptions inside `<p>` and `</p> `HTML tags. These can be sanitized depending on your formatting needs.
- [Get List of Data Subjects by Purpose](https://developer.onetrust.com/onetrust/reference/getdatasubjectsforpurposesusingget.md): Use this API to retrieve a list of data subjects by Purpose. The response will include details for each data subject such as the last transaction date, the transaction status for that Purpose, and Purpose Preferences they have interacted with.  > 🗒 Things to Know >  > - This API can be used as an alternative to the [Get List of Data Subjects](https://developer.onetrust.com/onetrust/reference/getdatasubjectprofileusingget) API when data subject records for a specific Purpose are required. > - This API returns Purpose descriptions inside `<p>` and `</p> `HTML tags. These can be sanitized depending on your formatting needs.
- [Get List of Purposes](https://developer.onetrust.com/onetrust/reference/getpurposesusingget.md): Gets a paged list of Purposes. We strongly suggest using GET /v2/purposes instead, as this endpoint has been deprecated.
- [Publish Purpose](https://developer.onetrust.com/onetrust/reference/publishpurposeusingput.md): Use this API to publish a Purpose. Before calling this API, ensure that the Purpose is in **Draft** status. The Purpose will be published with version **1** and **Active** status.  > 🗒 Things to Know >  > - The [Update Purpose](https://developer.onetrust.com/onetrust/reference/editpurposeusingput) API can be used to edit an existing Purpose before publishing. > - Once the Purpose is published, the previous version of the Purpose will be set to **Retired** status. > - This API returns Purpose descriptions inside `<p>` and `</p> `HTML tags. These can be sanitized depending on your formatting needs.
- [Retire Purpose](https://developer.onetrust.com/onetrust/reference/setretirementusingput.md): Use this API to set the retirement date for a specific Purpose.   > 🗒 Things to Know >  > - If the `date` query parameter is left empty, the date will be set to one day in the future by default. > - Data subjects who gave consent to the specified Purpose will be automatically updated after Purpose expiration. A summary of details about this transaction will appear on the Purposes and Receipts tabs of the Data Subject details screen in the OneTrust application for each profile associated to the Purpose. For more information, see [Managing Data Subjects](https://my.onetrust.com/s/article/UUID-3d2d8d5e-e9d7-ac43-4ee1-818a4c4e8932) and [Viewing Consent Receipts & Transactions](https://my.onetrust.com/s/article/UUID-17b03e29-c3b5-c5dc-a172-b2a180f9a826). > - This API returns Purpose descriptions inside `<p>` and `</p> `HTML tags. These can be sanitized depending on your formatting needs.
- [Get List of Receipts](https://developer.onetrust.com/onetrust/reference/getreceiptlistdetailsusingpost.md): Use this API to retrieve a list of all receipts. Depending on the query or header parameter values passed in the request, the response will return specific details about receipts, including relevant information about collection point interactions, purposes, and the associated purpose preferences and attributes.  > 🗒 Things to Know >  > - The timespan between the `fromDate` and `toDate` values must be 24 hours or less. > - By default, this API retrieves receipts created within the last 90 days. To retrieve receipts stored for more than 90 days, the `includeArchived` parameter must be used. > - When retrieving historic receipts, set `includeArchived=true` and provide either the `receiptId` in the request parameters or the `identifier` in the request headers. Optional parameters such as `includeDataElements`, `includeConsentStrings`, `sort`, `page`, and `nextMarker` can also be used. > - If `includeArchived=true` is set and additional parameters such as `fromDate or `toDate` are included, this API will instead search only receipts stored within the last 90 days. > - If the number of records exceeds a single page: >   - The response returns a `requestContinuation` value, which must be included in the next request body to continue pagination. >   - When retrieving archived receipts, `nextMarker` must also be included in subsequent request bodies to paginate through results. > - Purpose descriptions in the API response are returned inside `<p>` and `</p>` HTML tags. These tags can be sanitized based on your formatting needs.
- [Get Receipt](https://developer.onetrust.com/onetrust/reference/findreceiptusingget.md): > ❗️ End of Support Notification >  > As of September 1, 2024, these APIs are now deprecated. Any customers leveraging these APIs are encouraged to migrate to the [Receipts V2 API](https://developer.onetrust.com/onetrust/reference/getreceiptlistdetailsusingpost). For more information, see [OneTrust API Sunsetting & Deprecation Guidelines](https://developer.onetrust.com/onetrust/reference/onetrust-api-sunsetting-deprecation-guidelines).  Use this API to retrieve a single receipt by its unique identifier. The response will return information such as the receipt interaction date along with details of the Purposes that the data subject has interacted with, and their corresponding statuses.
- [Get List of Receipt Details by Data Subject](https://developer.onetrust.com/onetrust/reference/getreceiptlistdetailsusingget.md): > ❗️ End of Support Notification >  > As of September 1, 2024, these APIs are now deprecated. Any customers leveraging these APIs are encouraged to migrate to the [Receipts V2 API](https://developer.onetrust.com/onetrust/reference/getreceiptlistdetailsusingpost). For more information, see [OneTrust API Sunsetting & Deprecation Guidelines](https://developer.onetrust.com/onetrust/reference/onetrust-api-sunsetting-deprecation-guidelines).  Use this API to retrieve a list of consent receipts for a given data subject along with details such as the associated Purposes, Purpose Preferences, and attributes. The response will also include relevant information about the latest Collection Point interactions and the current status of consent.
- [Get List of Receipts by Data Subject](https://developer.onetrust.com/onetrust/reference/getreceiptlistusingget.md): > ❗️ End of Support Notification >  > As of September 1, 2024, these APIs are now deprecated. Any customers leveraging these APIs are encouraged to migrate to the [Receipts V2 API](https://developer.onetrust.com/onetrust/reference/getreceiptlistdetailsusingpost). For more information, see [OneTrust API Sunsetting & Deprecation Guidelines](https://developer.onetrust.com/onetrust/reference/onetrust-api-sunsetting-deprecation-guidelines).  Use this API to retrieve a list of consent receipts for a given data subject.
- [Get List of Transactions](https://developer.onetrust.com/onetrust/reference/gettransactionsusingpost.md): Use this API to retrieve a list of all consent transactions. The response will include information about each transaction, the corresponding consent date, and details of the Purposes and the associated Purpose Preferences that the data subject has interacted with.  > 🗒 Things to Know >  > - The timespan for the `fromDate` and `toDate` values must be 24 hours or less. > - The `collectionPointAttributes` parameter will be returned as `null` when left blank during normal ingestion (API collection point, webform) and as `{} ` when left blank during bulk import.
- [Withdraw Consent on Behalf of a Data Subject](https://developer.onetrust.com/onetrust/reference/withdrawtransactionbehalfofdatasubjectusingput.md): Use this API to withdraw consent on behalf of a data subject for a specific Purpose. The data subject identifier must be included either in the `identifier` query or header parameter, preferably passed in the header.
- [Withdraw Data Subject's Consent](https://developer.onetrust.com/onetrust/reference/withdrawtransactionbypurposeandidentifierusingget.md): Use this API to withdraw a data subject's consent for a specific Purpose. The data subject identifier must be included either in the `identifier` query or header parameter, preferably passed in the header.  > 🗒 Things to Know >  > - This API is not designed to be used in synchronous workflows. As an alternative, the [Create Consent Receipts ](https://developer.onetrust.com/onetrust/reference/createconsentreceiptusingpost) API can be called.
- [Get Catalog Search Results](https://developer.onetrust.com/onetrust/reference/externalsearch.md): Use this API to retrieve a list of all catalog search results by key terms and filters. The response will include relevant details for each result, including the corresponding data asset ID, name, and the associated tags and terms.  > 🗒 Things to Know > > - This API returns up to 100,000 catalog search results. For larger volumes, use the [Get Catalog Search Results V2](https://developer.onetrust.com/onetrust/reference/externalsearch-using-continuationtoken) API.
- [Get Search Fields](https://developer.onetrust.com/onetrust/reference/get_v1-field-details.md): Use this API to retrieve a list of all catalog search fields. The response will include details such as the search field names, data types, and supported operators.
- [Get Catalog Search Results](https://developer.onetrust.com/onetrust/reference/externalsearch-using-continuationtoken.md): Use this API to retrieve a list of all catalog search results by key terms and filters. The response will include relevant details for each result, including the corresponding data asset ID, name, and the associated tags and terms. This API is designed to return large volumes of catalog search results.  > 🗒 Things to Know > > - The `continuationToken` parameter returned in the response can be used on a subsequent API call to retrieve the next set of catalog search results. For more information, see [Understanding & Implementing Pagination](https://developer.onetrust.com/onetrust/reference/understanding-implementing-pagination#request-continuation-based-keyset--cursor-based-pagination).
- [Get List of Data Asset Attributes](https://developer.onetrust.com/onetrust/reference/getalldataassetattributenames.md): Use this API to retrieve a list of all data asset attributes in the Attribute Manager.
- [Get Data Asset Attribute](https://developer.onetrust.com/onetrust/reference/getdataassetattributebyname.md): Use this API to retrieve the details for the specified data asset attribute.
- [Delete Multiple Data Asset Tag Associations](https://developer.onetrust.com/onetrust/reference/deletedataassettagassociationsv1-1.md): Use this API to delete multiple tag associations from a specified data asset using its ID. The request should include the asset ID and a list of tags to be removed. The response will confirm the successful removal of associations and return the updated asset ID.
- [Delete Multiple Data Asset Term Associations](https://developer.onetrust.com/onetrust/reference/deletedataassettermassociationsv1-1.md): Use this API to delete multiple term associations from a specified data asset using its ID. The request should include the asset ID and a list of terms to be removed. The response will confirm the successful removal of associations and return the updated asset ID.
- [Create Tag Associations](https://developer.onetrust.com/onetrust/reference/createdataassettagassociationsv1-1.md): Use this API to create tag associations for the specified data asset. The request should include the data asset ID and the list of tags to assign to the data asset. The response will confirm the successful associations and return the updated data asset ID.
- [Create Term Associations](https://developer.onetrust.com/onetrust/reference/createdataassettermassociationsv1-1.md): Use this API to create term associations for the specified data asset. The request should include the data asset ID and the list of terms to assign to the data asset. The response will confirm the successful associations and return the updated data asset ID.
- [Create Data Asset](https://developer.onetrust.com/onetrust/reference/createorupsertdataassetv1-1.md): Use this API to create a new data asset or upsert an existing data asset. Data assets must be added using a structured top-down hierarchy to ensure consistent data organization. The request must include all required data asset details, such as the parent ID, name, type, and data source. The response will confirm successful ingestion with the assigned data asset ID.  Things to Know - If terms, tags, additional attributes, or users are added to an existing data asset, the system will merge the new values from the request with the existing values. - With the exception of the root (data source) node, every data asset must have its parent record already present in the system before being added.
- [Delete Data Asset](https://developer.onetrust.com/onetrust/reference/deletedataassetv1-1.md): Use this API to delete a data asset. The request must include the data asset ID, and the response will confirm acceptance of the deletion request. If the data asset has child objects, those objects will also be deleted asynchronously along with the parent data asset.
- [Get Data Asset](https://developer.onetrust.com/onetrust/reference/getdataassetv1-1.md): Use this API to retrieve a specific data asset. The response will include details such as the data source, additional attributes, associated terms, and associated tags.
- [Modify Data Asset](https://developer.onetrust.com/onetrust/reference/updatedataassetv1-1.md): Use this API to modify existing data assets while maintaining a structured top-down hierarchy. With this API, the system will replace existing terms, tags, additional attributes, or users with the new data included in the request. The response will confirm the status along with the updated data asset ID.
- [Get Glossary](https://developer.onetrust.com/onetrust/reference/getallglossariesbynames.md): Use this API to retrieve the details for the specified business glossary. The response will include details such as the glossary ID, description, and created date.
- [Get List of Glossaries](https://developer.onetrust.com/onetrust/reference/getallglossariesnames.md): Use this API to retrieve a list of all business glossaries.
- [Create Tag](https://developer.onetrust.com/onetrust/reference/createtagv2.md): Use this API to create a new tag in the Glossary.  > 🗒 Things to Know > > - The `type` parameter is case-sensitive. For example, use CATEGORY instead of Category.
- [Get Tag](https://developer.onetrust.com/onetrust/reference/gettagdetailswithassociatedterms.md): Use this API to retrieve the details for the specified tag.
- [Get List of Tags](https://developer.onetrust.com/onetrust/reference/retrievealltagsname.md): Use this API to retrieve a list of all tag names.
- [Create Term](https://developer.onetrust.com/onetrust/reference/createtermusingpost.md): Use this API to create a new term in the Glossary.
- [Get List of Term Attributes](https://developer.onetrust.com/onetrust/reference/getalltermattributenames.md): Use this API to retrieve a list of all term attributes created by internal and external systems.
- [Get Term Attribute](https://developer.onetrust.com/onetrust/reference/gettermattributebyname.md): Use this API to retrieve the details of a specific term attribute.
- [Get List of Terms](https://developer.onetrust.com/onetrust/reference/retrieveallterms.md): Use this API to retrieve a list of all terms or search for a specific term. The response will include details for each term along with the corresponding term ID, name, and glossary to which the term belongs.
- [Get Term](https://developer.onetrust.com/onetrust/reference/retrievetermsbyname.md): Use this API to retrieve the details for the specified term. The response will return the term ID, description, and type along with its associated tags.
- [Get List of Term Names](https://developer.onetrust.com/onetrust/reference/retrievetermsname.md): Use this API to retrieve a list of all term names.
- [Submit Data to Catalog](https://developer.onetrust.com/onetrust/reference/catalogdatausingpost.md): Use this API to submit metadata for cataloging for a given custom connector scan job.
- [Submit Data to Classify](https://developer.onetrust.com/onetrust/reference/classifydatausingpost.md): Use this API to submit content for classification for a given custom connecter scan job.
- [Get List of Scan Jobs](https://developer.onetrust.com/onetrust/reference/geteligiblejobsusingget.md): Use this API to get details of any pending custom connecter scan jobs for the specified data source.
- [Update Scan Job Status](https://developer.onetrust.com/onetrust/reference/updatejobstatususingput.md): Use this API to update the custom connecter scan job's status.
- [Create Custom Classifier](https://developer.onetrust.com/onetrust/reference/createdetector.md): Use this API to create a custom classifier.
- [Delete Custom Classifier](https://developer.onetrust.com/onetrust/reference/deletedetector.md): Use this API to delete a custom classifier.
- [Get Custom Classifier](https://developer.onetrust.com/onetrust/reference/getdetectorbyclassifiername.md): Use this API to retrieve a specific custom classifier. The response will include details such as the detector type, detection rules, last modified date, and created date.
- [Get List of Custom Classifiers](https://developer.onetrust.com/onetrust/reference/listdetectors.md): Use this API to retrieve a list of all custom classifiers. The response will include details such as the classifier name, ID, and detector type.
- [Update Custom Classifier](https://developer.onetrust.com/onetrust/reference/updatedetector.md): Use this API to update an existing custom classifier.
- [Create Credential](https://developer.onetrust.com/onetrust/reference/createcredential.md): Use this API to create a new credential.
- [Delete Credential](https://developer.onetrust.com/onetrust/reference/deletecredential.md): Use this API to delete an existing credential and its associated reference keys.
- [Get Credential](https://developer.onetrust.com/onetrust/reference/getcredentialbyid.md): Use this API to retrieve a single credential by its unique identifier.
- [Get List of Credentials](https://developer.onetrust.com/onetrust/reference/getcredentials.md): Use this API to retrieve a list of all credentials. The response will include details such as the credential name, ID, and reference key.
- [Update Credential](https://developer.onetrust.com/onetrust/reference/updatecredential.md): Use this API to update an existing credential.
- [Delete Data Source](https://developer.onetrust.com/onetrust/reference/deletesystemusingdelete_1.md): Use this API to delete an existing data source and its associated scan results.
- [Get List of Data Sources](https://developer.onetrust.com/onetrust/reference/getallusingget_1.md): Use this API to retrieve a list of data sources in JSON format. The response will include details for each data source along with the corresponding data source ID, system name, and associated settings.
- [Get Data Source](https://developer.onetrust.com/onetrust/reference/getdatasourcebyidusingget_1.md): Use this API to retrieve a single data source in JSON format by its unique identifier.
- [Create or Update Data Source](https://developer.onetrust.com/onetrust/reference/upsertsourcesystemv3usingput.md): Use this API to create a new data source or update an existing data source. The data source will be created or updated with the details provided in the request body.
- [Get List of Image tags](https://developer.onetrust.com/onetrust/reference/getdockerrepositorytagsusingget.md): Use this API to retrieve a list of all Docker images for a specific worker node version.  > 🗒 Things to Know > > - The list of Docker images will be returned in the following format: [REPOSITORY[ : TAG]], where tag stands for version number.
- [Cancel Scan Job](https://developer.onetrust.com/onetrust/reference/canceljobusingpatch.md): Use this API to cancel an existing scan job by its unique identifier. The job must be in a cancellable state (PENDING, PROCESSING, PAUSING). Jobs that are already COMPLETED, FAILED, CANCELLED, or CANCELLING cannot be cancelled. The cancellation is asynchronous - the job status will change to CANCELLING immediately, then to CANCELLED once the worker node acknowledges the cancellation.
- [Cancel Scan Job](https://developer.onetrust.com/onetrust/reference/cancelscanjob.md): Use this API to cancel an existing scan job by its unique identifier.
- [Create Scan Job](https://developer.onetrust.com/onetrust/reference/createjobusingpost.md): Use this API to create a new scan job in the specified data source.
- [Get Scan Job](https://developer.onetrust.com/onetrust/reference/getjobbyidusingget.md): Use this API to retrieve details of a specific scan job by its unique identifier. Returns comprehensive job information including status, progress, timestamps, metadata counts, scan profile used, and ingestion status.
- [Get Scan Job](https://developer.onetrust.com/onetrust/reference/getjobusingget_1.md): Use this API to retrieve a single scan job in JSON format by its unique identifier.
- [Get List of Scan Jobs](https://developer.onetrust.com/onetrust/reference/getscanjobsbydatasourceusingget_1.md): Use this API to retrieve a list of all scan jobs in JSON format for the specified data source. The response will include relevant details for each scan job, including the corresponding scan job ID, created date, and cancelled date.
- [Create Scan Profile](https://developer.onetrust.com/onetrust/reference/createv2usingpost.md): Use this API to create a new scan profile.
- [Delete Scan Profile](https://developer.onetrust.com/onetrust/reference/deletescanprofileusingdelete_1.md): Use this API to delete an existing scan profile.
- [Get List of Scan Profiles](https://developer.onetrust.com/onetrust/reference/getallusingget_2.md): Use this API to retrieve a list of all scan profiles. The response will include details for each scan profile along with the corresponding scan profile ID and its associated scan type, system, and paths.
- [Get Scan Profile](https://developer.onetrust.com/onetrust/reference/getscanprofileusingget_1.md): Use this API to retrieve a single scan profile by its unique identifier along with the associated scan type, system, and paths.
- [Update Scan Profile](https://developer.onetrust.com/onetrust/reference/updatev2usingput.md): Use this API to update an existing scan profile.
- [Create Emission Factor](https://developer.onetrust.com/onetrust/reference/addemissionfactor.md): Use this API to create emission factor.  ### Example Request  `POST https://{hostname}/api/esg-management/v1/entity-types/names/emission-factors/entities`  `POST https://trial.onetrust.com/api/esg-management/v1/entity-types/names/emission-factors/entities`
- [Create Emission Transaction](https://developer.onetrust.com/onetrust/reference/addemissiontransaction.md): Use this API to create emission transaction.  ### Additional Information  * Emission Factors names and id list can be obtained using the [Retrieve Emission Factors list](/onetrust/reference/getAllEmissionFactorsBasicEntityDetails) API. Use the required id to fill the emissionFactorId field in entityDetail.  ### Example Request  `POST https://{hostname}/api/esg-management/v1/entity-types/names/emission-transactions/entities`  `POST https://trial.onetrust.com/api/esg-management/v1/entity-types/names/emission-transactions/entities`
- [Get List of Emission Details](https://developer.onetrust.com/onetrust/reference/findallbytypeandcriteria.md): Use this API to get list of Emission Details by Criteria.  ### Additional Information  *  Filtering can be added in the request body.  ### Example Request  `POST https://{hostname}/api/esg-management/v1/entity-types/names/{entityTypeName}/entities/pages`  `POST https://trial.onetrust.com/api/esg-management/v1/entity-types/names/{entityTypeName}/entities/pages`
- [Get List of Emission Factors](https://developer.onetrust.com/onetrust/reference/getallemissionfactorsbasicentitydetails.md): Use this API to get list of emission factors.  ### Example Request  `GET https://{hostname}/api/esg-management/v1/emission-factors`  `GET https://trial.onetrust.com/api/esg-management/v1/emission-factors`
- [Get Metric Details](https://developer.onetrust.com/onetrust/reference/fetchmetricsdetails.md): Retrieve the latest details of ESG metrics based on Reporting Period.  ### Example Request  `POST https://{hostname}/api/esg-management/v1/metrics/metric-details`  `POST https://trial.onetrust.com/api/esg-management/v1/metrics/metric-details`  Below are the examples of request body to retrieve Metric Details.  ```json Example 1 {   "startDate": "2019-01-01",   "endDate": "2019-12-31" } ``` ```json Example 2 {    "allTimeOption": "ESG.Metric.MetricData.AllTimeReportingPeriodOption" } ```
- [LLMs.txt: AI Integration Guide](https://developer.onetrust.com/onetrust/reference/llmstxt-ai-integration-guide.md)
- [Connect to the MCP Server (Model Context Protocol)](https://developer.onetrust.com/onetrust/reference/mcp.md)
- [OAuth 2.0 Scopes](https://developer.onetrust.com/onetrust/reference/oauth-20-scopes.md)
- [OneTrust API Reference](https://developer.onetrust.com/onetrust/reference/onetrust-api-reference.md)
- [Quick Start Guide: APIs](https://developer.onetrust.com/onetrust/reference/quick-start-guide.md)
- [URL Variables for APIs & SDKs](https://developer.onetrust.com/onetrust/reference/url-variables-for-apis-sdks.md)
- [Get Audit Records for Login History](https://developer.onetrust.com/onetrust/reference/loginhistory.md): Use this API to retrieve the login history of all users or a specific user for audit purposes.  > 🗒 Things to Know > > - If a date range and specific `userId` is not specified in the request, the response will include the login history for all users over the past 7 days. > - If a date range is not specified but a specific `userId` is specified in the request, the response will include the login history for that specific user over the past 365 days. > - If a date range is specified but a specific `userId` is not specified in the request, the response will include the login history for all users over the specified date range. > - If the date range does not fall within the last 365 days, the response will return an error.
- [Get Audit Records for User's Profile](https://developer.onetrust.com/onetrust/reference/useractivity.md): Use this API to retrieve a list of changes made to a user's profile for audit purposes. The response will include a history of changes made to the user's details, roles, and organizations.
- [Generate Access Token](https://developer.onetrust.com/onetrust/reference/getoauthtoken-1.md): Use this API to generate an OAuth access token using the `client_credentials` grant type.  > 🗒 Things to Know > > - Client credentials can be generated from within Global Settings in the OneTrust application. For more information, see [Managing OAuth 2.0 Client Credentials](/onetrust/docs/managing-oauth-20-client-credentials). > - Use the `client_id` and `client_secret` to generate the OAuth access token using this API. > - A maximum of 500 OAuth 2.0 client credentials can be created per account.
- [Create Organization](https://developer.onetrust.com/onetrust/reference/createorganizationusingpost.md): Use this API to create an organization within the organizational hierarchy.  > 🗒 Things to Know > > - The organization will be created as a child of the organization specified in the `parentExternalId` parameter. If a `parentExternalId`value is not specified in the request, the organization will be created as a child of the root organization.
- [Delete Organization](https://developer.onetrust.com/onetrust/reference/deleteorganizationpost.md): Use this API to delete an existing organization and move its associated objects to a different organization.
- [Get List of Organizations](https://developer.onetrust.com/onetrust/reference/organizationtreestructureusingget.md): Use this API to retrieve a list of all organizations within the organizational hierarchy.
- [Update Organization](https://developer.onetrust.com/onetrust/reference/updateorganizationusingput.md): Use this API to update the details of an existing organization within the organizational hierarchy.
- [Add User Group Roles](https://developer.onetrust.com/onetrust/reference/addaccesslevelsforusergroupbyidv2.md): Use this API to add a new role to a user group.
- [Add User to User Group](https://developer.onetrust.com/onetrust/reference/addamemberforusergroupbyidv2.md): Use this API to add a single user to a specified user group.
- [Add Multiple Users to User Group](https://developer.onetrust.com/onetrust/reference/addmultiplemembersforusergroupbyidv2.md): Use this API to add multiple users to a specified user group in bulk.
- [Create User Group](https://developer.onetrust.com/onetrust/reference/createusergroupv2.md): Use this API to create a new user group with a specified name and description.
- [Delete User Group](https://developer.onetrust.com/onetrust/reference/deleteusergroupbyidv2.md): Use this API to delete an existing user group by its unique identifier.
- [Get User Group Roles](https://developer.onetrust.com/onetrust/reference/getaccesslevelsforusergroupbyidv2.md): Use this API to retrieve a list of roles for a specific user group.
- [Get List of User Groups](https://developer.onetrust.com/onetrust/reference/getallusergroupwithfiltersv2.md): Use this API to retrieve a list of user groups, with support for pagination and filtering.
- [Get List of Users in User Group](https://developer.onetrust.com/onetrust/reference/getmembersfromausergroupbyidv2.md): Use this API to retrieve a paginated list of members in a specified user group.
- [Get User Group](https://developer.onetrust.com/onetrust/reference/getusergroupbyidv2.md): Use this API to retrieve a specific user group by its unique identifier.
- [Remove User Group Roles](https://developer.onetrust.com/onetrust/reference/removeaccesslevelforusergroupbyidv2.md): Use this API to remove roles from a specific user group.
- [Remove User from User Group](https://developer.onetrust.com/onetrust/reference/removeamemberforusergroupbyidv2.md): Use this API to remove a single user from a specified user group.
- [Remove Multiple Users from User Group](https://developer.onetrust.com/onetrust/reference/removemultiplemembersforusergroupbyidv2.md): Use this API to remove multiple users from a specified user group in bulk.
- [Update User Group Roles](https://developer.onetrust.com/onetrust/reference/updateaccesslevelforusergroupbyidv2.md): Use this API to update the roles of a user group by replacing the current set of roles with a new one.
- [Update User Group](https://developer.onetrust.com/onetrust/reference/updateusergroupbyidv2.md): Use this API to update the attributes of an existing user group by its unique identifier.
- [Add Members to User Group](https://developer.onetrust.com/onetrust/reference/addmembersusingpost.md): Use this API to add users as members of a specific user group.   > 🗒 Things to Know > > - When a user is added as a member of a user group, the user inherits the role and organization configured for that user group. If the user belongs to other user groups, the user will still retain existing membership with those groups in addition to their other existing roles and permissions. > - The `userId` of the users to be added to the user group can be specified in the request body in a comma separated list.
- [Create User Group](https://developer.onetrust.com/onetrust/reference/createusergroupusingpost.md): Use this API to create a new user group.
- [Delete User Group](https://developer.onetrust.com/onetrust/reference/deleteusergroupusingdelete.md): Use this API to delete an existing user group.
- [Remove Members from User Group](https://developer.onetrust.com/onetrust/reference/removemembersusingdelete.md): Use this API to remove users as members of a specific user group.  > 🗒 Things to Know > > - The `userId` of the users to be removed from the user group can be specified in the request body in a comma separated list.
- [Get User Group Members](https://developer.onetrust.com/onetrust/reference/retrievemembersusingget.md): Use this API to retrieve a list of users that are members of a specific user group.
- [Get List of User Groups](https://developer.onetrust.com/onetrust/reference/retrieveusergroupsusingget.md): Use this API to retrieve a list of user groups.
- [Update User Group](https://developer.onetrust.com/onetrust/reference/updateusergroupusingput.md): Use this API to update the name and description of a specific user group.
- [Add User Role](https://developer.onetrust.com/onetrust/reference/adduseraccesslevelv2.md): Use this API to add a new role to a specific user.
- [Create User](https://developer.onetrust.com/onetrust/reference/createuserv2.md): Use this API to create a new user in your account.
- [Get List of Users](https://developer.onetrust.com/onetrust/reference/getalluserdetailsv2.md): Use this API to retrieve a list of all users in your account.
- [Get User Roles](https://developer.onetrust.com/onetrust/reference/getuseraccesslevelsv2.md): Use this API to retrieve a list of roles assigned to a specific user.
- [Get User](https://developer.onetrust.com/onetrust/reference/getuserv2.md): Use this API to retrieve details for a single user in your account.
- [Remove User Role](https://developer.onetrust.com/onetrust/reference/removeuseraccesslevelv2.md): Use this API to remove a specific role from a user.
- [Modify User Default Organization](https://developer.onetrust.com/onetrust/reference/setuserdefaultorganizationv2.md): Use this API to modify the default organization for a specific user. The user must have at least one role in the specified organization.
- [Update User](https://developer.onetrust.com/onetrust/reference/updateuserv2.md): Use this API to update the details for a single user in your account.
- [Cancel Bulk Export](https://developer.onetrust.com/onetrust/reference/cancelbulkexportdelete.md): Use this API to cancel a bulk export that has not been completed.
- [Get Bulk Export Download Details](https://developer.onetrust.com/onetrust/reference/getattachmentdownloadcommandsget.md): Use this API to retrieve the download details for a bulk export. The response will include the authorization token (expires after 1 hour), file name, and URL that you can include within the following cURL command to download the export files:  ```curl curl --header "Authorization: Bearer <TOKEN_FROM_RESPONSE>" --output "<FILENAME_FROM_RESPONSE>" -fL "URL_FROM_RESPONSE" ```  > 🗒 Things to Know >  > - Your export may generate multiple files to preserve download speeds. Each file name and URL will contain a unique authorization token.
- [Get Bulk Export Credit Details](https://developer.onetrust.com/onetrust/reference/getcreditsinformationget.md): Use this API to retrieve bulk export credit details for the account. The response will include the total number of credits available for the account along with the number of credits remaining and the number of credits used.  > 🗒 Things to Know >  > - Each account is limited to 20 bulk exports per month. If you cancel a bulk export before it completes, it will not be counted towards this limit. Please contact OneTrust Support or your Customer Success Manager (CSM) to increase your export limit.
- [Get Bulk Export Status](https://developer.onetrust.com/onetrust/reference/getexportrundetailsget.md): Use this API to retrieve the current status and progress of a bulk export.  > 🗒 Things to Know >  > - The `status` of a bulk export will automatically change to `Expired` 10 days after its creation.
- [Get List of Bulk Exports](https://developer.onetrust.com/onetrust/reference/getexportrunsget.md): Use this API to retrieve a list of bulk exports. The response will include the created date, ID, and status of each export.  > 🗒 Things to Know >  > - The `status` of a bulk export will automatically change to `Expired` 10 days after its creation.
- [Get List of Bulk Export Download Details](https://developer.onetrust.com/onetrust/reference/getpaginatedattachmentdownloadcommandsget.md): Use this paginated API to retrieve the download details for a bulk export. The response will include the authorization token (expires after 1 hour), file name, and URL that you can include within the following cURL command to download the export files:  ```curl curl --header "Authorization: Bearer <TOKEN_FROM_RESPONSE>" --output "<FILENAME_FROM_RESPONSE>" -fL "URL_FROM_RESPONSE" ```  > 🗒 Things to Know >  > - Your export may generate multiple files to preserve download speeds. Each file name and URL will contain a unique authorization token.
- [Create Bulk Export](https://developer.onetrust.com/onetrust/reference/startexportrunpost.md): Use this API to create a bulk export based on the specified criteria.  > 🗒 Things to Know >  > - For `COOKIE_RECEIPTS` exports, please reach out to your OneTrust representative or production support before running.  > - Each account is limited to 20 bulk exports per month. If you cancel a bulk export before it completes, it will not be counted towards this limit. Please contact OneTrust Support or your Customer Success Manager (CSM) to increase your export limit. > - The timespan for endDate-startDate is limited to 6 months.  > - `endDate` can be as recent as yesterday, but cannot be the current day. > - `CONSENT_RECEIPTS` and `COOKIE_RECEIPTS` only support  filtering based on`collectionPointGuid` or `purposeGuid`.  Both cannot be used at the same time. > - `CONSENT_RECEIPTS` and `COOKIE_RECEIPTS` exports will become available once the feature is enabled. > - For `DATA_SUBJECTS` exports, only data subjects with a recorded consent transaction will be included. > - If a value is not provided for the `dateType` parameter in `DATA_SUBJECTS` exports, this will be set to `CREATED_DATE` by default. > - The `status` of a bulk export will automatically change to `Expired` 10 days after its creation. > - For bulk exports less than 1 million records, we recommend using a report to pull the list. As it cannot be guaranteed that the bulk export reaches this maximum, the results will be split across multiple files up to 1 million records. > - The maximum limit allowed is 1 million records, which is equivalent to approximately 8MB for `COOKIE_RECEIPTS` and `CONSENT_RECEIPTS` exports.  ```json Consent Receipts with Collection Point Filter {   "exportType": "CONSENT_RECEIPTS",   "startDate": "2023-07-01",   "endDate": "2023-12-01",   "params": [     {       "name": "collectionPointGuid",       "values": [         "af01cad5-a39d-4585-9ee1-2062b1426bdd"       ]     }   ] } ``` ```json Cookie Receipts with Purpose Filter {   "exportType": "COOKIE_RECEIPTS",   "startDate": "2023-11-01",   "endDate": "2023-12-01",   "params": [     {       "name": "purposeGuid",       "values": [         "af01cad5-a39d-4585-9ee1-2062b1426bdd"       ]     }   ] } ``` ```json Data Subjects with Filters {     "exportType": "DATA_SUBJECTS",     "startDate": "2024-01-01",     "endDate": "2024-06-01",     "params": [         {             "name": "lastTransactionCollectionPointId",             "values": [                 "c0431f94-664b-431e-bff3-3b341571c2af"             ]         },         {             "name": "purposeId",             "values": [                 "514780d1-7797-4952-84e7-d6c70b018fed",                 "fb1ec920-68cd-4c9a-99da-77b21bd5b9d5",                 "55ede8d8-0aab-40b8-a6b7-6c5221b62aa7"             ]         },         {             "name": "status",             "values": [                 "ACTIVE"             ]         },         {             "name": "dataElementName",             "values":[                 "FirstName"             ]         },                 {             "name": "dataElementValue",             "values":[                 "George"             ]         }     ] } ```
- [Get File Location](https://developer.onetrust.com/onetrust/reference/filelocation.md): Use this API to obtain the location of an uploaded file. The location can be identified by the `downloadUrl` parameter included in the response.
- [Upload File](https://developer.onetrust.com/onetrust/reference/fileupload.md): Use this API to upload a file up to 64MB to the OneTrust Platform. The response will include the `Id` and `FileName` parameters, which can be used to attach the file to a product within the platform.  > 🗒 Things to Know >  > - The extension of the uploaded file must be in one of the supported file formats. For more information, see [Using the Document Repository](https://my.onetrust.com/s/article/UUID-24981513-4770-b8a1-b365-cc8b7fdb1712). > - The `attachment` parameter below includes the following information:  >   - `Parameters & Descriptions` contains details on the list of parameters and expected parameter values. This should be used for reference only. >   - `Attachment JSON Object` contains the required format in which the parameters and parameter values must be sent in the request.
- [Create System Credential](https://developer.onetrust.com/onetrust/reference/createv2usingpost-1.md): Use this API to create a new credential for a specific connector type.
- [Update System Credential](https://developer.onetrust.com/onetrust/reference/updatev2usingput-1.md): Use this API to update details for an existing credential.
- [Export Workflow](https://developer.onetrust.com/onetrust/reference/exportworkflowusingget_1.md): Use this API to export an integration workflow as a JSON file.
- [Import Workflow](https://developer.onetrust.com/onetrust/reference/importworkflowusingpost_1.md): Use this API to import an integration workflow from a provided JSON file.
- [Create Relationship](https://developer.onetrust.com/onetrust/reference/createinventoryrelationsusingpost.md): Use this API to create a bidirectional link between an inventory and one or more other inventories.
- [Delete Relationship by Type Name](https://developer.onetrust.com/onetrust/reference/deleteinventoryrelationsusingrelationshiptypename_1.md): Use this API to remove a contextual link between two entities.
- [Delete Relationship by Type ID](https://developer.onetrust.com/onetrust/reference/deleteinventoryrelationsusingrelationshiptypename.md): Use this API to remove a contextual link between two entities.
- [Get Relationship by Type Name](https://developer.onetrust.com/onetrust/reference/getinventoryrelationshipusingrelationshiptypename_1.md): Use this API to get relationship details created between entities.
- [Get Relationship by Type ID](https://developer.onetrust.com/onetrust/reference/getinventoryrelationshipusingrelationshiptypename.md): Use this API to get relationship details created between entities.
- [Get Personal Data for Relationship by Type Name](https://developer.onetrust.com/onetrust/reference/getpersonaldataforrelationshipsusingpost_1.md): Use this API to get Personal Data for a Relationship.
- [Get Personal Data for Relationship by Type ID](https://developer.onetrust.com/onetrust/reference/getpersonaldataforrelationshipsusingpost.md): Use this API to get Personal Data for a Relationship.
- [Link or Unlink Personal Data to Relationship by Type Name](https://developer.onetrust.com/onetrust/reference/linkorunlinkinventoryrelationshipsusingrelationshipusingput_1.md): Use this API to link or Unlink the personal data to a relationship.
- [Link or Unlink Personal Data to Relationship by Type ID](https://developer.onetrust.com/onetrust/reference/linkorunlinkinventoryrelationshipsusingrelationshipusingput.md): Use this API to link or Unlink the personal data to a relationship.
- [Get List of Relationships](https://developer.onetrust.com/onetrust/reference/listallinventoryrelationshipsusingpost.md): Use this API to get all relationships for an Inventory.
- [Update Relationship by Type Name](https://developer.onetrust.com/onetrust/reference/updateinventoryrelationsusingentitytypename_1.md): Use this API to modify a contextual link between two entities.
- [Update Relationship by Type ID](https://developer.onetrust.com/onetrust/reference/updateinventoryrelationsusingentitytypename.md): Use this API to modify a contextual link between two entities.
- [Create Relationship](https://developer.onetrust.com/onetrust/reference/addrelationshipbetweenentitiesusingpost.md): Use this API to create a Relationship Record between inventories (Assets, Vendors, Processing Activities, and Entities).
- [Create Model Object](https://developer.onetrust.com/onetrust/reference/createmodelusingpost.md): Use this API to create a new Model object record.  > 🗒 Things to Know >  > - This API only supports creating Model objects via Object Manager.
- [Delete Model Object](https://developer.onetrust.com/onetrust/reference/deletemodelusingdelete.md): Use this API to delete an existing Model object record.  > 🗒 Things to Know >  > - This API only supports Model objects created via Object Manager.
- [Get Basic Model Object Details](https://developer.onetrust.com/onetrust/reference/findmodelbasicdetailsbyquerycriteriausingpost.md): Use this API to retrieve basic details for the specified Model object record by key terms and filters.  > 🗒 Things to Know >  > - This API only supports Model objects created via Object Manager.
- [Get Model Object Details](https://developer.onetrust.com/onetrust/reference/findmodelsbylistcriteriausingpost.md): Use this API to retrieve all the details for the Model object record by key terms and filters.  > 🗒 Things to Know >  > - This API only supports Model objects created via Object Manager.
- [Get Model Object](https://developer.onetrust.com/onetrust/reference/getmodelusingget.md): Use this API to retrieve a single Model object record by its unique identifier along with the associated attributes, module name, and created date.  > 🗒 Things to Know >  > - This API only supports Model objects created via Object Manager.
- [Modify Model Object](https://developer.onetrust.com/onetrust/reference/updatemodelusingput.md): Use this API to partially update an existing Model object record.  > 🗒 Things to Know >  > - This API only supports Model objects created via Object Manager.
- [Add Attribute to Schema](https://developer.onetrust.com/onetrust/reference/addattributeusingpost-1.md): Use this API to add an attribute to a specific schema.  > 🗒 Things to Know >  > - This API only supports objects created via Object Manager, including Projects, Models, and Datasets.
- [Add Options to Attribute](https://developer.onetrust.com/onetrust/reference/addoptionsusingpost.md): Use this API to add options to an attribute.  > 🗒 Things to Know >  > - This API only supports objects created via Object Manager, including Projects, Models, and Datasets.
- [Disable Attribute](https://developer.onetrust.com/onetrust/reference/disableattributeusingput.md): Use this API to disable an attribute.  > 🗒 Things to Know >  > - This API only supports objects created via Object Manager, including Projects, Models, and Datasets.
- [Enable Attribute](https://developer.onetrust.com/onetrust/reference/enableattributeusingput.md): Use this API to enable an attribute.  > 🗒 Things to Know >  > - This API only supports objects created via Object Manager, including Projects, Models, and Datasets.
- [Create Object](https://developer.onetrust.com/onetrust/reference/addentityusingentitytypeidorentitytypenameusingpost.md): Use this API to create a new object record.  > 🗒 Things to Know >  > - This API only supports creating Projects, Models, and Datasets objects via Object Manager.
- [Delete Object](https://developer.onetrust.com/onetrust/reference/deleteusingentitytypeidorentitytypenameusingdelete.md): Use this API to delete an existing object record.  > 🗒 Things to Know >  > - This API only supports objects created via Object Manager, including Projects, Models, and Datasets.
- [Get Full Object Details](https://developer.onetrust.com/onetrust/reference/findallbytypeidandcriteriausingpost.md): Use this API to retrieve all the details for the specified object record by key terms and filters.  > 🗒 Things to Know >  > - This API only supports objects created via Object Manager, including Projects, Models, and Datasets.
- [Get Basic Object Details](https://developer.onetrust.com/onetrust/reference/findentitybasicdetailsbytypeandcriteriausingpost.md): Use this API to retrieve basic details for the specified object record by key terms and filters.  > 🗒 Things to Know >  > - This API only supports objects created via Object Manager, including Projects, Models, and Datasets.
- [Get Object](https://developer.onetrust.com/onetrust/reference/getentityinformationusingentitytypeidorentitytypenameusingget.md): Use this API to retrieve a single object record by its unique identifier along with the associated attributes, module name, and created date.  > 🗒 Things to Know >  > - This API only supports objects created via Object Manager, including Projects, Models, and Datasets.
- [Modify Object](https://developer.onetrust.com/onetrust/reference/updateusingentitytypeidorentitytypenameusingpatch.md): Use this API to partially update an existing object record.  > 🗒 Things to Know >  > - This API only supports objects created via Object Manager, including Projects, Models, and Datasets.
- [Create Relationship Record between Objects](https://developer.onetrust.com/onetrust/reference/createlinkrecordbetweenentitiesusinglinktypeidusingpost.md): Use this API to create a new Relationship Record between objects.  > 🗒 Things to Know >  > - This API only supports objects created via Object Manager, including Projects, Models, and Datasets.
- [Remove Relationship Record](https://developer.onetrust.com/onetrust/reference/deletelinkrecordbyidandtypeusinglinktypeidusingdelete.md): Use this API to delete an existing Relationship Record between objects.  > 🗒 Things to Know >  > - This API only supports objects created via Object Manager, including Projects, Models, and Datasets.
- [Get Relationship Record](https://developer.onetrust.com/onetrust/reference/getlinkrecordinformationusinglinktypeidusingget.md): Use this API to retrieve the details of a specific Relationship Record between objects.  > 🗒 Things to Know >  > - This API only supports objects created via Object Manager, including Projects, Models, and Datasets.
- [Create Relationship Type between Objects](https://developer.onetrust.com/onetrust/reference/createcustomlinktypeusingpost.md): Use this API to create a new Relationship Type between two object types.  > 🗒 Things to Know >  > - This API only supports objects created via Object Manager, including Projects, Models, and Datasets.
- [Get List of Relationship Link Types](https://developer.onetrust.com/onetrust/reference/findallbylinktypeandcriteriausingpost.md): Use this API to retrieve a list of all Relationship Types by key terms and filters.  > 🗒 Things to Know >  > - This API only supports objects created via Object Manager, including Projects, Models, and Datasets.
- [Get Relationship Type](https://developer.onetrust.com/onetrust/reference/getlinktypeusingget.md): Use this API to retrieve the details of a single Relationship Type by its unique identifier.  > 🗒 Things to Know >  > - This API only supports objects created via Object Manager, including Projects, Models, and Datasets.
- [Create Task](https://developer.onetrust.com/onetrust/reference/createtaskusingpost_1.md): Use this API to create a new task for an object.  > 🗒 Things to Know >  > - This API only supports objects created via Object Manager, including Projects, Models, and Datasets.
- [Get Task](https://developer.onetrust.com/onetrust/reference/findtaskusingget_1.md): Use this API to retrieve a specific task on an object. The response will include details such as the activity history, assignee, and deadline.  > 🗒 Things to Know >  > - This API only supports objects created via Object Manager, including Projects, Models, and Datasets.
- [Update Task](https://developer.onetrust.com/onetrust/reference/updatetaskusingput_1.md): Use this API to update an existing task for an object.  > 🗒 Things to Know >  > - This API only supports objects created via Object Manager, including Projects, Models, and Datasets.
- [Enable Custom Object Type by Name](https://developer.onetrust.com/onetrust/reference/enabledcustomentitytypeusingput_1.md): Use this API to enable the object type by its name.  > 🗒 Things to Know >  > - This API only supports objects created via Object Manager, including Projects, Models, and Datasets.
- [Enable Custom Object Type by ID](https://developer.onetrust.com/onetrust/reference/enabledcustomentitytypeusingput.md): Use this API to enable the object type by its unique identifier.  > 🗒 Things to Know >  > - This API only supports objects created via Object Manager, including Projects, Models, and Datasets.
- [Get List of Object Types](https://developer.onetrust.com/onetrust/reference/findallbytypeandcriteriausingpost.md): Use this API to retrieve a list of all object types by key terms and filters.  > 🗒 Things to Know >  > - This API only supports objects created via Object Manager, including Projects, Models, and Datasets.
- [Get Object Type by Name](https://developer.onetrust.com/onetrust/reference/getentitytypeinformationusingget_1.md): Use this API to retrieve details for the object type by its name. The response will return the user who created the object type, created date, and description.  > 🗒 Things to Know >  > - This API only supports objects created via Object Manager, including Projects, Models, and Datasets.
- [Get Object Type by ID](https://developer.onetrust.com/onetrust/reference/getentitytypeinformationusingget.md): Use this API to retrieve details for the object type by its unique identifier. The response will return the user who created the object type, created date, and description.  > 🗒 Things to Know >  > - This API only supports objects created via Object Manager, including Projects, Models, and Datasets.
- [Modify Custom Object Type by Name](https://developer.onetrust.com/onetrust/reference/updatecustomentitytypeusingpatch_1.md): Use this API to partially update an existing object type by its name.  > 🗒 Things to Know >  > - This API only supports objects created via Object Manager, including Projects, Models, and Datasets.
- [Modify Custom Object Type by ID](https://developer.onetrust.com/onetrust/reference/updatecustomentitytypeusingpatch.md): Use this API to partially update an existing object type by its unique identifier.  > 🗒 Things to Know >  > - This API only supports objects created via Object Manager, including Projects, Models, and Datasets.
- [Create Project Object](https://developer.onetrust.com/onetrust/reference/createprojectusingpost.md): Use this API to create a new Project object record.  > 🗒 Things to Know >  > - This API only supports creating Project objects via Object Manager.
- [Delete Project Object](https://developer.onetrust.com/onetrust/reference/deleteprojectusingdelete.md): Use this API to delete an existing Project object record.  > 🗒 Things to Know >  > - This API only supports Project objects created via Object Manager.
- [Get Basic Project Object Details](https://developer.onetrust.com/onetrust/reference/findprojectbasicdetailsbyquerycriteriausingpost.md): Use this API to retrieve basic details for the specified Project object record by key terms and filters.  > 🗒 Things to Know >  > - This API only supports Project objects created via Object Manager.
- [Get Project Object Details](https://developer.onetrust.com/onetrust/reference/findprojectsbylistcriteriausingpost.md): Use this API to retrieve all the details for the Project object record by key terms and filters.  > 🗒 Things to Know >  > - This API only supports Project objects created via Object Manager.
- [Get Project Object](https://developer.onetrust.com/onetrust/reference/getprojectusingget.md): Use this API to retrieve a single Project object record by its unique identifier along with the associated attributes, module name, and created date.  > 🗒 Things to Know >  > - This API only supports Project objects created via Object Manager.
- [Modify Project Object](https://developer.onetrust.com/onetrust/reference/updateprojectusingput.md): Use this API to partially update an existing Project object record.  > 🗒 Things to Know >  > - This API only supports Project objects created via Object Manager.
- [Create task](https://developer.onetrust.com/onetrust/reference/createtaskusingpost-2.md): Creates a new task
- [Get Task](https://developer.onetrust.com/onetrust/reference/gettaskbyidandtasktypenamekeyusingget.md): Retrieves task details by its unique identifier and task type name key
- [Update task](https://developer.onetrust.com/onetrust/reference/updatetaskusingput.md): Updates an existing task by its ID and task type name key
- [Get Group](https://developer.onetrust.com/onetrust/reference/getgroupresourceusingget.md): Use this API to retrieve details for a specific SCIM group. The response will include details such as the created date, last modified date, and list of users within the SCIM group. This API should only be used when provisioning and managing users from your Identity Provider using the System for Cross-Domain Identity Management (SCIM) standard to facilitate the automated creation of user identities from a third-party identity management application.  > 🗒 Things to Know > > - This API supports OneTrust's Legacy SCIM Integration that leverages SCIM groups, which are unique role-organization combinations that each represent a specific role within a particular organization. For more information, see [Legacy SCIM User Provisioning](https://my.onetrust.com/s/article/UUID-abda73a7-4996-c1b4-2e2a-e46aa3f2a3cc).
- [Get List of Groups](https://developer.onetrust.com/onetrust/reference/listgroupsusingget.md): Use this API to retrieve a list of SCIM groups from your account. The response will include each unique role-organization combination. For example, if your account has 20 roles and 2 organizations, this API will return 40 unique SCIM groups in the response. This API should only be used when provisioning and managing users from your Identity Provider using the System for Cross-Domain Identity Management (SCIM) standard to facilitate the automated creation of user identities from a third-party identity management application.  > 🗒 Things to Know > > - This API supports OneTrust's Legacy SCIM Integration that leverages SCIM groups, which are unique role-organization combinations that each represent a specific role within a particular organization. For more information, see [Legacy SCIM User Provisioning](https://my.onetrust.com/s/article/UUID-abda73a7-4996-c1b4-2e2a-e46aa3f2a3cc).
- [Modify Group](https://developer.onetrust.com/onetrust/reference/updategroupmembersusingpatch.md): Use this API to partially update SCIM group details and/or SCIM group membership. This API should only be used when provisioning and managing users from your Identity Provider using the System for Cross-Domain Identity Management (SCIM) standard to facilitate the automated creation of user identities from a third-party identity management application.  > 🗒 Things to Know >  > - This API supports OneTrust's Legacy SCIM Integration that leverages SCIM groups, which are unique role-organization combinations that each represent a specific role within a particular organization. For more information, see [Legacy SCIM User Provisioning](https://my.onetrust.com/s/article/UUID-abda73a7-4996-c1b4-2e2a-e46aa3f2a3cc). > - When a user is added as a member of a SCIM group, the user is provisioned with that specific role-organization combination. If the user belongs to other SCIM groups, the user will still retain existing membership with those groups as users can be assigned to multiple roles and multiple organizations.
- [Update Group](https://developer.onetrust.com/onetrust/reference/updategroupmembersusingput.md): Use this API to fully update SCIM group details and SCIM group membership. This API should only be used when provisioning and managing users from your Identity Provider using the System for Cross-Domain Identity Management (SCIM) standard to facilitate the automated creation of user identities from a third-party identity management application.  > 🗒 Things to Know > > - This API supports OneTrust's Legacy SCIM Integration that leverages SCIM groups, which are unique role-organization combinations that each represent a specific role within a particular organization. For more information, see [Legacy SCIM User Provisioning](https://my.onetrust.com/s/article/UUID-abda73a7-4996-c1b4-2e2a-e46aa3f2a3cc). > - When a user is added as a member of a SCIM group, the user is provisioned with that specific role-organization combination. If the user belongs to other SCIM groups, the user will still retain existing membership with those groups as users can be assigned to multiple roles and multiple organizations. > - When this API is called, the existing list of users that are members of the SCIM group will be replaced with the new list of users defined in the request. If no users are specified, the existing list of users will be removed from the SCIM group.
- [Get Supported Resource Types](https://developer.onetrust.com/onetrust/reference/getresourcetypesbynameusingget.md): Use this API to retrieve the supported resource types for the supported SCIM resources (i.e. User and Group). The response will include the endpoint URL, core schema URI, supported schema extensions, and other metadata that indicate where a resource is managed and how it is composed. This API should only be used when provisioning and managing users from your Identity Provider using the System for Cross-Domain Identity Management (SCIM) standard to facilitate the automated creation of user identities from a third-party identity management application.  > 🗒 Things to Know > > - This API supports OneTrust's Legacy SCIM Integration that leverages SCIM groups, which are unique role-organization combinations that each represent a specific role within a particular organization. For more information, see [Legacy SCIM User Provisioning](https://my.onetrust.com/s/article/UUID-abda73a7-4996-c1b4-2e2a-e46aa3f2a3cc).
- [Get Supported Resources](https://developer.onetrust.com/onetrust/reference/getresourcetypesusingget.md): Use this API to retrieve the supported SCIM resources (i.e. User and Group). This API should only be used when provisioning and managing users from your Identity Provider using the System for Cross-Domain Identity Management (SCIM) standard to facilitate the automated creation of user identities from a third-party identity management application.  > 🗒 Things to Know > > - This API supports OneTrust's Legacy SCIM Integration that leverages SCIM groups, which are unique role-organization combinations that each represent a specific role within a particular organization. For more information, see [Legacy SCIM User Provisioning](https://my.onetrust.com/s/article/UUID-abda73a7-4996-c1b4-2e2a-e46aa3f2a3cc).
- [Get SCIM Schema](https://developer.onetrust.com/onetrust/reference/getschemasbynameusingget.md): Use this API to retrieve details of a specific schema supported by SCIM 2.0 specifications. The response will include a collection of attributes that describe the contents of the specified SCIM resource. The attribute definitions specify the name of the attribute, metadata such as type (string, binary), cardinality (singular, multi, complex), mutability, and returnability. This API should only be used when provisioning and managing users from your Identity Provider using the System for Cross-Domain Identity Management (SCIM) standard to facilitate the automated creation of user identities from a third-party identity management application.  > 🗒 Things to Know > > - This API supports OneTrust's Legacy SCIM Integration that leverages SCIM groups, which are unique role-organization combinations that each represent a specific role within a particular organization. For more information, see [Legacy SCIM User Provisioning](https://my.onetrust.com/s/article/UUID-abda73a7-4996-c1b4-2e2a-e46aa3f2a3cc).
- [Get List of Supported SCIM Schemas](https://developer.onetrust.com/onetrust/reference/getschemasusingget.md): Use this API to retrieve a list of schemas supported by SCIM 2.0 specifications. The response will include a collection of attributes that describe the contents of SCIM resources (i.e. User and Group). The attribute definitions specify the name of the attribute, metadata such as type (string, binary), cardinality (singular, multi, complex), mutability, and returnability. This API should only be used when provisioning and managing users from your Identity Provider using the System for Cross-Domain Identity Management (SCIM) standard to facilitate the automated creation of user identities from a third-party identity management application.  > 🗒 Things to Know > > - This API supports OneTrust's Legacy SCIM Integration that leverages SCIM groups, which are unique role-organization combinations that each represent a specific role within a particular organization. For more information, see [Legacy SCIM User Provisioning](https://my.onetrust.com/s/article/UUID-abda73a7-4996-c1b4-2e2a-e46aa3f2a3cc).
- [Get Service Provider Configuration](https://developer.onetrust.com/onetrust/reference/getserviceproviderconfigusingget.md): Use this API to retrieve the service provider configuration resource. The service provider configuration resource enables discovery of SCIM specification features in a standardized form and provides additional implementation details. This API should only be used when provisioning and managing users from your Identity Provider using the System for Cross-Domain Identity Management (SCIM) standard to facilitate the automated creation of user identities from a third-party identity management application.  > 🗒 Things to Know > > - This API supports OneTrust's Legacy SCIM Integration that leverages SCIM groups, which are unique role-organization combinations that each represent a specific role within a particular organization. For more information, see [Legacy SCIM User Provisioning](https://my.onetrust.com/s/article/UUID-abda73a7-4996-c1b4-2e2a-e46aa3f2a3cc).
- [Create User Group](https://developer.onetrust.com/onetrust/reference/creategroup.md): Use this API to create a user group. This API should only be used when provisioning and managing users from your Identity Provider using the System for Cross-Domain Identity Management (SCIM) standard to facilitate the automated creation of user identities from a third-party identity management application.  > 🗒 Things to Know > > - This API supports OneTrust's Enhanced SCIM Integration that leverages Group Provisioning to manage access for users by provisioning them to one or more user groups. For more information, see [SCIM User & Group Provisioning](https://my.onetrust.com/s/article/UUID-93f936ef-8076-280c-a58e-ba2d3437dfad).
- [Delete User Group](https://developer.onetrust.com/onetrust/reference/deletegroup.md): Use this API to delete a specific user group. This API should only be used when provisioning and managing users from your Identity Provider using the System for Cross-Domain Identity Management (SCIM) standard to facilitate the automated creation of user identities from a third-party identity management application.  > 🗒 Things to Know > > - This API supports OneTrust's Enhanced SCIM Integration that leverages Group Provisioning to manage access for users by provisioning them to one or more user groups. For more information, see [SCIM User & Group Provisioning](https://my.onetrust.com/s/article/UUID-93f936ef-8076-280c-a58e-ba2d3437dfad).
- [Get User Group](https://developer.onetrust.com/onetrust/reference/getgroupbyid.md): Use this API to retrieve details for a specific user group. This API should only be used when provisioning and managing users from your Identity Provider using the System for Cross-Domain Identity Management (SCIM) standard to facilitate the automated creation of user identities from a third-party identity management application.  > 🗒 Things to Know > > - This API supports OneTrust's Enhanced SCIM Integration that leverages Group Provisioning to manage access for users by provisioning them to one or more user groups. For more information, see [SCIM User & Group Provisioning](https://my.onetrust.com/s/article/UUID-93f936ef-8076-280c-a58e-ba2d3437dfad).
- [Get List of User Groups](https://developer.onetrust.com/onetrust/reference/getgroups.md): Use this API to retrieve a list of user groups. This API should only be used when provisioning and managing users from your Identity Provider using the System for Cross-Domain Identity Management (SCIM) standard to facilitate the automated creation of user identities from a third-party identity management application.  > 🗒 Things to Know > > - This API supports OneTrust's Enhanced SCIM Integration that leverages Group Provisioning to manage access for users by provisioning them to one or more user groups. For more information, see [SCIM User & Group Provisioning](https://my.onetrust.com/s/article/UUID-93f936ef-8076-280c-a58e-ba2d3437dfad). > - OneTrust supports the use of SCIM filters to identify specific user groups: > - Filters can be applied on the `displayName` attribute. > - The supported logical operators are `eq` (equal) and `co` (contains). > - The `filter` query parameter is applied in the following format: attribute operator "value". For example, displayName co "Sales" would return a list of user group records that contain sales in the display name.
- [Modify User Group](https://developer.onetrust.com/onetrust/reference/modifygroup.md): Use this API to partially update user group details and/or user group membership. This API should only be used when provisioning and managing users from your Identity Provider using the System for Cross-Domain Identity Management (SCIM) standard to facilitate the automated creation of user identities from a third-party identity management application.  > 🗒 Things to Know > > - This API supports OneTrust's Enhanced SCIM Integration that leverages Group Provisioning to manage access for users by provisioning them to one or more user groups. For more information, see [SCIM User & Group Provisioning](https://my.onetrust.com/s/article/UUID-93f936ef-8076-280c-a58e-ba2d3437dfad). > - When a user is added as a member of a user group, the user is provisioned with the role and organization configured for that user group. If the user belongs to other user groups, the user will still retain existing membership with those groups as users can be assigned to multiple roles and multiple organizations.
- [Update User Group](https://developer.onetrust.com/onetrust/reference/updategroup.md): Use this API to fully update user group details and user group membership. This API should only be used when provisioning and managing users from your Identity Provider using the System for Cross-Domain Identity Management (SCIM) standard to facilitate the automated creation of user identities from a third-party identity management application.  > 🗒 Things to Know > > - This API supports OneTrust's Enhanced SCIM Integration that leverages Group Provisioning to manage access for users by provisioning them to one or more user groups. For more information, see [SCIM User & Group Provisioning](https://my.onetrust.com/s/article/UUID-93f936ef-8076-280c-a58e-ba2d3437dfad). > - When this API is called, the existing list of users that are members of the user group will be replaced with the new list of users defined in the request. If no users are specified, the existing list of users will be removed from the user group.
- [Create User](https://developer.onetrust.com/onetrust/reference/createuserusingpost.md): Use this API to create a user and associate that user with the configured organization and role. This API should only be used when provisioning and managing users from your Identity Provider using the System for Cross-Domain Identity Management (SCIM) standard to facilitate the automated creation of user identities from a third-party identity management application.  > 🗒 Things to Know > > - This API supports OneTrust's Legacy SCIM Integration that leverages SCIM groups, which are unique role-organization combinations that each represent a specific role within a particular organization. For more information, see [Legacy SCIM User Provisioning](https://my.onetrust.com/s/article/UUID-abda73a7-4996-c1b4-2e2a-e46aa3f2a3cc). > - If a value is not provided for `roles` or `organization` in the request, the newly created user will be assigned the default role and organization as configured on the **User Provisioning** screen within **Global Settings** in the OneTrust application. > - This API supports assigning the user to multiple roles within one organization. If the user should be assigned to other role-organization combinations (SCIM groups), use the [Modify Group Members](https://developer.onetrust.com/onetrust/reference/updategroupmembersusingpatch) API.
- [Delete User](https://developer.onetrust.com/onetrust/reference/deleteuserusingdelete.md): The Delete User feature is not available at this time.
- [Get List of Users](https://developer.onetrust.com/onetrust/reference/getallusersusingget.md): Use this API to retrieve a list of users along with user details such as the created date, last modified date, name, and email. This API should only be used when provisioning and managing users from your Identity Provider using the System for Cross-Domain Identity Management (SCIM) standard to facilitate the automated creation of user identities from a third-party identity management application.  > 🗒 Things to Know > > - This API supports OneTrust's Legacy SCIM Integration that leverages SCIM groups, which are unique role-organization combinations that each represent a specific role within a particular organization. For more information, see [Legacy SCIM User Provisioning](https://my.onetrust.com/s/article/UUID-abda73a7-4996-c1b4-2e2a-e46aa3f2a3cc). > - OneTrust supports the use of SCIM filters to identify specific users: > - Filters can be applied on the `id`, `externalId`, `email`, `emails`, `givenName`, `familyName`, `userType`, and `active` attributes. > - The supported logical operators are `eq` (equal), `co` (contains), `sw` (starts with), `gt` (greater than), `ge` (greater than or equal to), `lt` (less than), and `le` (less than or equal to). > - The `filter` query parameter is applied in the following format: attribute operator "value". For example, emails co "onetrust.com" would return a list of user records that contain emails with the onetrust.com domain.
- [Get User](https://developer.onetrust.com/onetrust/reference/getuserusingget.md): Use this API to retrieve the details of a specific user. The response will include details such as the created date, emails, and SCIM groups to which the user belongs. This API should only be used when provisioning and managing users from your Identity Provider using the System for Cross-Domain Identity Management (SCIM) standard to facilitate the automated creation of user identities from a third-party identity management application.  > 🗒 Things to Know > > - This API supports OneTrust's Legacy SCIM Integration that leverages SCIM groups, which are unique role-organization combinations that each represent a specific role within a particular organization. For more information, see [Legacy SCIM User Provisioning](https://my.onetrust.com/s/article/UUID-abda73a7-4996-c1b4-2e2a-e46aa3f2a3cc).
- [Modify User](https://developer.onetrust.com/onetrust/reference/patchuserusingpatch.md): Use this API to activate a user, deactivate a user, or partially update a user's attributes. This API should only be used when provisioning and managing users from your Identity Provider using the System for Cross-Domain Identity Management (SCIM) standard to facilitate the automated creation of user identities from a third-party identity management application.  > 🗒 Things to Know > > - This API supports OneTrust's Legacy SCIM Integration that leverages SCIM groups, which are unique role-organization combinations that each represent a specific role within a particular organization. For more information, see [Legacy SCIM User Provisioning](https://my.onetrust.com/s/article/UUID-abda73a7-4996-c1b4-2e2a-e46aa3f2a3cc). > - The following user attributes can be modified using this API: `givenName`, `familyName`, `externalId`, `active`, `division`, `userType`, `employeeNumber`, `department`, `manager`, and `title`.
- [Update User](https://developer.onetrust.com/onetrust/reference/updateuserusingput.md): Use this API to fully update all attributes for a user. This API should only be used when provisioning and managing users from your Identity Provider using the System for Cross-Domain Identity Management (SCIM) standard to facilitate the automated creation of user identities from a third-party identity management application.  > 🗒 Things to Know > > - This API supports OneTrust's Legacy SCIM Integration that leverages SCIM groups, which are unique role-organization combinations that each represent a specific role within a particular organization. For more information, see [Legacy SCIM User Provisioning](https://my.onetrust.com/s/article/UUID-abda73a7-4996-c1b4-2e2a-e46aa3f2a3cc). > - The following user attributes will be updated using this API: `givenName`, `familyName`, `externalId`, `active`, `division`, `userType`, `employeeNumber`, `department`, `manager`, and `title`. > - Any attributes not included in the request will be replaced with a `null` value. It is best to first retrieve the latest user record using the [Get User](https://developer.onetrust.com/onetrust/reference/getuserusingget) API, and then modify that response to use in the request for this API. If you only need to update some but not all attributes, use the [Modify User](https://developer.onetrust.com/onetrust/reference/patchuserusingpatch) API.
- [Create User](https://developer.onetrust.com/onetrust/reference/createuser.md): Use this API to create a user and associate that user with the configured organization and role. This API should only be used when provisioning and managing users from your Identity Provider using the System for Cross-Domain Identity Management (SCIM) standard to facilitate the automated creation of user identities from a third-party identity management application.  > 🗒 Things to Know > > - This API supports OneTrust's Enhanced SCIM Integration that leverages Group Provisioning to manage access for users by provisioning them to one or more user groups. For more information, see [SCIM User & Group Provisioning](https://my.onetrust.com/s/article/UUID-93f936ef-8076-280c-a58e-ba2d3437dfad). > - The response will always return the following values for roles and organization: `"roles": []` and `"organization": null`. > - If a value is not provided for roles or organization in the request, the newly created user will be assigned the default role and organization as configured on the **User Provisioning** screen within **Global Settings** in the OneTrust application. > - This API supports assigning the user to multiple roles within one organization. If the user should be assigned to other user groups, use the [Modify User Group](/onetrust/reference/updategroup) API.
- [Get User](https://developer.onetrust.com/onetrust/reference/getuserbyid.md): Use this API to retrieve the details of a specific user. The response will include details such as the created date, emails, and user groups to which the user belongs. This API should only be used when provisioning and managing users from your Identity Provider using the System for Cross-Domain Identity Management (SCIM) standard to facilitate the automated creation of user identities from a third-party identity management application.  > 🗒 Things to Know > > - This API supports OneTrust's Enhanced SCIM Integration that leverages Group Provisioning to manage access for users by provisioning them to one or more user groups. For more information, see [SCIM User & Group Provisioning](https://my.onetrust.com/s/article/UUID-93f936ef-8076-280c-a58e-ba2d3437dfad). > - The response will always return the following values for roles and organization: `"roles": []` and `"organization": null`.
- [Get List of Users](https://developer.onetrust.com/onetrust/reference/getusers.md): Use this API to retrieve a list of users along with user details such as the created date, last modified date, name, and email. This API should only be used when provisioning and managing users from your Identity Provider using the System for Cross-Domain Identity Management (SCIM) standard to facilitate the automated creation of user identities from a third-party identity management application.  > 🗒 Things to Know > > - This API supports OneTrust's Enhanced SCIM Integration that leverages Group Provisioning to manage access for users by provisioning them to one or more user groups. For more information, see [SCIM User & Group Provisioning](https://my.onetrust.com/s/article/UUID-93f936ef-8076-280c-a58e-ba2d3437dfad). > - The response will always return the following values for roles and organization: `"roles": []` and `"organization": null`. > - OneTrust supports the use of SCIM filters to identify specific users: > - Filters can be applied on the `id`, `externalId`, `email`, `emails`, `givenName`, `familyName`, `userType`, and `active` attributes. > - The supported logical operators are `eq` (equal), `co` (contains), `sw` (starts with), `gt` (greater than), `ge` (greater than or equal to), `lt` (less than), and `le` (less than or equal to). > - The `filter` query parameter is applied in the following format: attribute operator "value". For example, emails co "onetrust.com" would return a list of user records that contain emails with the onetrust.com domain.
- [Modify User](https://developer.onetrust.com/onetrust/reference/modifyuser.md): Use this API to activate a user, deactivate a user, or partially update a user's attributes. This API should only be used when provisioning and managing users from your Identity Provider using the System for Cross-Domain Identity Management (SCIM) standard to facilitate the automated creation of user identities from a third-party identity management application.  > 🗒 Things to Know > > - This API supports OneTrust's Enhanced SCIM Integration that leverages Group Provisioning to manage access for users by provisioning them to one or more user groups. For more information, see [SCIM User & Group Provisioning](https://my.onetrust.com/s/article/UUID-93f936ef-8076-280c-a58e-ba2d3437dfad). > - The response will always return the following values for roles and organization: `"roles": []` and `"organization": null`. > - The `path` parameter is optional and should only be used when updating a single user attribute. For example, if you only wanted to update the `externalId`, then your `path` would be `externalId` and your `value` would be a `string`. If no `path` is provided, you must build out a JSON body for updating the user's attributes.
- [Update User](https://developer.onetrust.com/onetrust/reference/updateuser.md): Use this API to fully update all attributes for a user. This API should only be used when provisioning and managing users from your Identity Provider using the System for Cross-Domain Identity Management (SCIM) standard to facilitate the automated creation of user identities from a third-party identity management application.  > 🗒 Things to Know > > - This API supports OneTrust's Enhanced SCIM Integration that leverages Group Provisioning to manage access for users by provisioning them to one or more user groups. For more information, see [SCIM User & Group Provisioning](https://my.onetrust.com/s/article/UUID-93f936ef-8076-280c-a58e-ba2d3437dfad). > - The response will always return the following values for roles and organization: `"roles": []` and `"organization": null`. > - The following user attributes will be updated using this API: `givenName`, `familyName`, `externalId`, `active`, `division`, `employeeNumber`, `department`, `manager`, and `title`. > - Any attributes not included in the request will be replaced with a `null` value. It is best to first retrieve the latest user record using the [Get User](https://developer.onetrust.com/onetrust/reference/getuserbyid) API, and then modify that response to use in the request for this API. If you only need to update some but not all attributes, use the [Modify User](https://developer.onetrust.com/onetrust/reference/modifyuser) API.
- [Create Assessment Risk](https://developer.onetrust.com/onetrust/reference/createassessmentriskusingpost.md): Use this API to create a risk on an assessment. This API will return the risk owner, risk approver and target risk level in the response. The risk will be flagged on the assessment and assigned to the respective risk owners with the details defined in the API request body.    > 🗒 Things to Know  >   > - This API can be used for assessments in **Under Review** and **Completed** stage.  >  > - Risks must have an assigned risk owner before you can send a recommendation. Once an approver has identified a risk, they can send the risk owner a recommendation that helps to rectify and minimize the risk.  >  > - If risk heatmaps are used by your organization, the available risk level options will be based on the heatmap set up for your organization. If risk heatmaps are not used, the available risk level options will be **Low**, **Medium**, **High**, and **Very High**.
- [Complete Assessment](https://developer.onetrust.com/onetrust/reference/reviewassessmentusingpost.md): Use this API to complete review of an assessment using any active result option. This action will move the assessment to the **Completed** stage.    > 🗒 Things to Know   >    > - The assessment must first be submitted for review before using this API. This can be done using the [Submit Assessment ](https://developer.onetrust.com/onetrust/reference/submitassessmentusingpost)API.   >    > - Only active assessment result options can be used to complete assessments.
- [Submit Assessment](https://developer.onetrust.com/onetrust/reference/submitassessmentusingpost.md): Use this API to submit an assessment for review. This action will move the assessment to the **Under Review** stage.    > 🗒 Things to Know   >   > - Responses for all required questions must be first submitted before using this API. This action can be done using the [Submit Responses](https://developer.onetrust.com/onetrust/reference/submitresponsesusingpost) API.   > - Do not include the **Content-Type** parameter in the header, as this API does not accept a request body. For APIs that do accept a request body, set **Content-Type** to **application/json**, as our APIs only support application/json.
- [Submit Responses](https://developer.onetrust.com/onetrust/reference/submitresponsesusingpost.md): Use this API to submit responses for an assessment. The assessment will be updated with the submitted response.    > 🗒 Things to Know   >   > - Responses cannot be added to assessments that have already been completed.
- [Approve Assessment](https://developer.onetrust.com/onetrust/reference/approveassessmentusingpost.md): Use this API to move an assessment to Completed stage. The assessment should be submitted before invoking this API.
- [Launch Assessment](https://developer.onetrust.com/onetrust/reference/createassessmentusingpost_1.md): Use this API to launch a new assessment. The new assessment will be created with the details provided in the request body and assigned to the indicated respondents. If the selected template includes an 'Approver-only' Section, a user with the "Project Owner" permission can be assigned to that section.   > 🗒 Things to Know    >   > - `inventoryDetails` information can be added in order to set a primary record and pre-populate inventory information on the assessment.  >   > - The `templateRootVersionId` parameter can be used instead of the `templateId` parameter to create the new assessment using the latest published version of a template.
- [Launch Assessment](https://developer.onetrust.com/onetrust/reference/createassessmentusingpost.md): Use this API to launch a new assessment. The new assessment will be created with the details provided in the request body and assigned to the indicated respondents. If the selected template includes an 'Approver-only' Section, a user with the "Project Owner" permission can be assigned to that section.   > 🗒 Things to Know    >   > - `inventoryDetails` information can be added in order to set a primary record and pre-populate inventory information on the assessment.  >   > - The `templateRootVersionId` parameter can be used instead of the `templateId` parameter to create the new assessment using the latest published version of a template.
- [Launch Assessments in Bulk](https://developer.onetrust.com/onetrust/reference/createbulkassessmentusingpost.md): Use this API to create assessments in bulk. One assessment will be created for each inventory ID passed in the request body. The assessments will be created with the details provided in the request body and assigned to the indicated respondents.   > 🗒 Things to Know    >   > - The same template or different templates can be used per inventory ID in the API response body.  >   > - The `templateRootVersionId` parameter can be used instead of the `templateId` parameter to use the latest published version of a template for the new assessment.
- [Create Assessment Task](https://developer.onetrust.com/onetrust/reference/createtaskusingpost.md): Use this API to create new tasks on an assessment. Only a single task can be created on an assessment per API call.   > 🗒 Things to Know    >   > - Tasks cannot be created for the following assessment types:  >   > - Global Readiness Assessment  >  > - Readiness Assessment  >  > - Program Benchmarking  >  > - Dynamic Incident Notification Assessment
- [Reassess Assessment](https://developer.onetrust.com/onetrust/reference/reassessassessmentusingpost.md): Use this API to launch a reassessment of an existing assessment. The reassessment will use the latest published template version.  > 🗒 Things to Know    >   > - Basic assessment details, such as name, organization, deadline, reminder, approver, and respondent, can be copied from the source assessment to the new assessment if the `copyAssessmentMetadata` parameter is set to `true`. Otherwise, `assessmentMetadata` can be passed through the API when the `copyAssessmentMetadata` parameter is set to `false`.  >   > - The responses, comments, attachments, notes, and linked risks from the original assessment can also be copied to the new assessment using this API.  >   > - The `archiveSourceAssessment` parameter can be used to indicate whether to archive the source assessment or not.
- [Reassign Assessment](https://developer.onetrust.com/onetrust/reference/reassignassessmentusingput.md): Use this API to reassign the organization, approvers, and/or respondents of an assessment. The assessment will be updated with the new organization, approvers, and/or respondents provided in the request body.   > 🗒 Things to Know    >   > - If the assessment is in **Completed** stage, reassignments made using this API will be ignored.  >   > - The reassigned respondents and/or approvers should exist in the `orgGroupId` provided in the request.  >   > - New respondents that do not already exist in the application will be created as Invited Users unless `PROJECT_RESPONDENT` is specified in the `respondentCreationType` parameter.  >   > - If an update is made using this API, an event will be shown in the Assessment Activity.  >   > - This API can update assessments of the following types: PIA, Vendor, ITRM, Control, Exchange, and Incident.  >   > - The `stageId` parameter values returned in the [Get Assessment Workflow Stages](/onetrust/reference/getworkflowdetailsforassessmentusingget) API response can be used to reassign approvers to different stages of an assessment.
- [Reopen Assessment](https://developer.onetrust.com/onetrust/reference/reopenassessmentusingpost.md): Use this API to reopen a specific assessment to request more information from respondents. This action will move the assessment from the Completed stage to the Under Review stage and comments will be provided to the respondent in an email notification.
- [Send Back Assessment](https://developer.onetrust.com/onetrust/reference/sendbackassessmenttoinprogressusingpost.md): Use this API to send back a specific assessment to request more information from respondents. This action will move the assessment from the Under Review stage to the In Progress stage and comments will be provided to the respondent in an email notification.
- [Link Assessments](https://developer.onetrust.com/onetrust/reference/addmanualassessmentlinksusingpost.md): Use this API to link an assessment to multiple assessments.   > 🗒 Things to Know    >   > - This API can be used for linking active and archived assessments.  >   > - Only assessments with the following template types can be linked: PIA, Vendor, ITRM, Control, Exchange, Incident and ESG.
- [Update Assessment Tags](https://developer.onetrust.com/onetrust/reference/addorupdatetagsusingput.md): Use this API to update the tags associated with a specific assessment. The tags submitted through this API will overwrite all existing tags on the assessment.    > 🗒 Things to Know    >   > - The [Get Assessment](/onetrust/reference/exportassessmentusingget) API can be used to retrieve the current list of assessment tags for the specified assessment. You can include these tags within the request of this API to keep them on the assessment.  >  > - New tags can be created using this API and can then be associated with an assessment.
- [Archive Assessment](https://developer.onetrust.com/onetrust/reference/archiveassessmentsusingput.md): Use this API to archive a single assessment or multiple assessments. Multiple assessment IDs can be provided in the API request to archive assessments in bulk.   > 🗒 Things to Know    >   > - Archived assessments will be moved into the Archive list after archiving.  >   > - Archived assessments will be read-only.  >   > - Dynamic Incident Notification Assessments, Program Benchmarking Assessments, and Maturity & Planning Assessments cannot be archived.
- [Move Assessment to Recycle Bin](https://developer.onetrust.com/onetrust/reference/softdeleteassessmentusingput.md): Use this API to soft delete an assessment by moving it to the recycle bin. The assessment will then be stored in the recycle bin until it is either restored or permanently deleted.   > 🗒 Things to Know    >   > - Only assessments found in the PIA & DPIA Automation and IT & Security Risk Management modules can be soft deleted.  >  > - Dynamic Incident Notification Assessments, Program Benchmarking Assessments, and Maturity & Planning Assessments cannot be soft deleted.
- [Unarchive Assessment](https://developer.onetrust.com/onetrust/reference/unarchiveassessmentsusingput-1.md): Use this API to unarchive a single assessment or multiple assessments. Multiple assessment IDs can be provided in the API request to unarchive assessments in bulk.   > 🗒 Things to Know    >   > - Unarchived assessments will be moved back to the Active list after unarchiving.  >   > - Unarchived assessments will be editable.  >   > - Dynamic Incident Notification Assessments, Program Benchmarking Assessments, and Maturity & Planning Assessments cannot be unarchived.
- [Modify Assessment](https://developer.onetrust.com/onetrust/reference/updatebasicassessmentdetailsusingpatch.md): Use this API to update basic assessment details such as assessment name, assessment description, assessment deadline and reminder.    > 🗒 Things to Know    >   > - If the assessment is in **Completed** stage, updates made using this API will be ignored.  >   > - If an update is made using this API, an event will be shown in the Assessment Activity.  >   > - This API can update assessments of the following types: PIA, Vendor, ITRM, Control, Exchange and Incident.
- [Set Primary Record](https://developer.onetrust.com/onetrust/reference/updateprimaryrecordusingput.md): Use this API to edit the existing primary record or set a new primary record on an assessment. For the given `assessmentId`, the existing primary record will either be updated or a new primary record will be created using the attributes in the API request body.   > 🗒 Things to Know    >   > - If the template has a question with the primary record enabled, then the primary record is set as the response to that question and the related attributes and inventory questions will be pre-populated.  >   > - The primary record can be edited for Inventory and Assess Control primary record types.  >   > - The primary record list cannot be greater than 1 for Inventory primary record types.  >   > - The primary record list can be greater than 1 for Assess Control primary record types.
- [Get Assessment](https://developer.onetrust.com/onetrust/reference/exportassessmentusingget.md): Use this API to retrieve details of a specific assessment. The response will include details such as basic assessment information, respondents, approvers, assessment questions and responses, and assessment risks.
- [Get List of Assessments](https://developer.onetrust.com/onetrust/reference/getallassessmentbasicdetailsusingget.md): Use this API to retrieve a list of all assessments with basic assessment details. The response will include details such as the assessment ID, number, stage, result, and associated organization.   > 🗒 Things to Know    >  > - All assessments regardless of their stage are returned in the response by default.  >  > - The assessments can be filtered by stage using the `assessmentStatuses` query parameter.   >  > - The `size` and `page` query parameters can be used to paginate the response (list of assessments). The `size` parameter defines the number of assessments to be returned in each page. The `page` parameter defines the page number. The first page and default `page` is page number 0. The `size` parameter is optional and default value is 20, but cannot exceed 2000. If you input a value greater than 2000, then 2000 will be used for the `size`.
- [Export Deleted Assessment Audit Log](https://developer.onetrust.com/onetrust/reference/getassessmentdeletelogsusingget.md): Use this API to export a log of all deleted assessments. The response will include details such as the assessment name, assessment ID, user who deleted the assessment, and deletion timestamp.   > 🗒 Things to Know    >  > - The exported log only includes assessments deleted after OneTrust 4.1.
- [Get List of Assessment Results](https://developer.onetrust.com/onetrust/reference/getassessmentresultsusingget.md): Use this API to retrieve a list of all assessment result options that can be used to complete an assessment. The `id` corresponding to each result option in the response can be used to complete assessments using the [Complete Assessment](/onetrust/reference/reviewassessmentusingpost) API.
- [Get List of Assessments by Criteria](https://developer.onetrust.com/onetrust/reference/getassessmentsusingpost.md): Use this API to retrieve list of all the assessments or assessments by filter criteria like Approver Ids, Respondent Ids, Template Ids etc. The response will include details such as the assessment ID, number, stage, result, primary record, and associated organization.   > 🗒 Things to Know    >  > - All assessments regardless of their stage are returned in the response by default.  >  > - The assessments can be filtered by stage using the `assessmentStatuses, templateTypes, assessmentArchivalState` query parameter. Other than these commonly used filters, request body can be used to filter assessments by approver Ids, respondent Ids, template Ids, workflow stage name.
- [Get List of Linked Assessments](https://developer.onetrust.com/onetrust/reference/getlinkedassessmentsinformationusingget.md): Use this API to retrieve a list of all assessments linked to a particular record. The linked assessments list will support all copied, reassessed, and rule triggered related assessments.   > 🗒 Things to Know    >   > - The following APIs can be used to retrieve the record ID (`id`):   >   > - For Assets, Processing Activities, & Entities, use the [Get List of Inventories](/onetrust/reference/getlistofinventoriesusingget) API.  >   > - For Vendors, use the [List Vendors](/onetrust/reference/getlistofinventoriesusingget-1) API.  >   > - For Engagements, use the [Get List of Engagements](/onetrust/reference/loadengagementusingget) API.  >   > - For Incidents, use the [List Incidents](/onetrust/reference/searchincidentsusingpost) API.  >   > - For Control Implementations, use the [List Controls](/onetrust/reference/findallcontrolimplementationsusingpost) API.  >   > - If the ID does not match the entered reference-object from the URL, 0 results will be returned.
- [Get List of Assessment Tags](https://developer.onetrust.com/onetrust/reference/gettagsusingget.md): Use this API to retrieve all available assessment tags that can be used to categorize or label assessments.   > 🗒 Things to Know    >   > - The list of tag IDs returned in the response can be used to update a specific assessment's tag using the [Update Assessment Tags](/onetrust/reference/addorupdatetagsusingput) API.
- [Get Assessment Workflow Stages](https://developer.onetrust.com/onetrust/reference/getworkflowdetailsforassessmentusingget.md): Use this API to retrieve workflow and approval stage details of an assessment. The response will include details such as the workflow ID, workflow name, stage ID, and stage name.   > 🗒 Things to Know    >  > - Workflow stage indicates the current stage of the workflow that the assessment is in.
- [Delete Template](https://developer.onetrust.com/onetrust/reference/deletetemplateversionsusingdelete.md): The API can be used to delete a template using its root version identifier.   > 🗒 Things to Know  >   > - The template should not be associated with any Assessment or any action rules of other templates.  >  > - Template of specific types PIA, VENDOR, ITRM, CONTROL, INCIDENT, EXCHANGE, ESG, DISCLOSURE, ERM, TPDD, DISCLOSURE_YOY can be deleted using the API.  >  > - The root version identifier of a template can be retrieved by calling the [Get List of Templates](/onetrust/reference/getallbasictemplatedetailsusingget) API.
- [Export Template](https://developer.onetrust.com/onetrust/reference/exporttemplatewithbusinesskeysusingget.md): Use this API to export the metadata of a specific template in JSON format in order to migrate the template from one environment/tenant to another environment/tenant. The response body will be returned in JSON format and will include template details such as questions, rules, skip/show logic, etc.    > 🗒 Things to Know  >  > - The JSON response body returned by this API can be pasted within the [Import Template](https://developer.onetrust.com/onetrust/reference/importtemplatebyidusingpost) API's request body to import the metadata of the template into the environment/tenant.  > - The `templateRootVersionId` must be passed as the value for the `templateId` parameter if you are passing the `templateVersion` query parameter in the request.  > - The response of this API will vary based on whether the `templateVersion` parameter is passed.  > - If this parameter is not passed, then the template corresponding to the `templateId` will be exported.  > - If a specific version value is passed for this parameter, then that version of the template will be exported.  > - If `latest` is passed for this parameter, then the latest version of the template will be exported.
- [Get List of Templates](https://developer.onetrust.com/onetrust/reference/getallbasictemplatedetailsusingget.md): Use this API to retrieve the details of all the published templates. The response includes basic template details such as the template name, template root version ID, and template type.   > 🗒 Things to Know  >   > - The following template types are available:  >   > <details>  >   > <summary><b>Template Types</b></summary>  >   > CONTROL: Control templates created in IT & Security Risk Management  >   > DISCLOSURE: Disclosure Management  >   > ESG: ESG Program Reporting & Disclosures  >   > EXCHANGE: Third-Party Risk Exchange  >   > INCIDENT: Incident Management  >   > ITRM: IT & Security Risk Management  >   > PIA: PIA & DPIA Automation  >   > VENDOR: Third-Party Risk Management  >   > </details>  >   > - If the template type is not specified in the API request body, all template types will be included in the response.
- [Import Template](https://developer.onetrust.com/onetrust/reference/importtemplatebyidusingpost.md): Use this API to import the metadata of a specific template in JSON format in order to migrate the template from one environment/tenant to another environment/tenant. Before calling this API, use the [Export Template](/onetrust/reference/exporttemplatewithbusinesskeysusingget) API to obtain the template metadata in JSON format. The JSON response body obtained from the Export Template API can then be pasted within the Import Template request body (BODY PARAMS).   > 🗒 Things to Know  >   > - After the import, the template will reflect on the Templates page in Draft status.  >  > - If a template with the same name already exists on the destination environment, then the migration will fail (HTTP Response Status Code 400: Duplicate template name). Please ensure that no templates (Active or Archived) already exist with the same name as the template being migrated.  >  > - If your template contains questions linked to custom inventory attributes, it is crucial that the same attributes have already been created in the destination environment/tenant and are an identical match.
- [Get Attribute Options](https://developer.onetrust.com/onetrust/reference/get_inventory-v2-schemas-attributes-attributeid-values-valueid.md): Use this API to support the editing of attribute option names.  ### Example Request  `PUT https://{hostname}/api/inventory/v2/api/inventory/v2/schemas/attributes/{attributeId}/values/{valueId}`  `PUT https://trial.onetrust.com/api/inventory/v2/schemas/attributes/bcb8c972-cd10-4c2a-9289-44f8cc78ac03/values/98ec8ebc-90e7-4c3e-869f-cb1b1506222c`
- [Get Inventory Schema](https://developer.onetrust.com/onetrust/reference/getschemausingget_1.md): Use this API to retrieve the schema (attribute definitions) for a specific inventory type. The schema defines all available attributes, their types, and validation rules for the specified inventory category.  This is useful for understanding the structure of inventory records before creating or updating them, or for dynamically building forms and validation logic.  ### Example Request  `GET https://{hostname}/api/inventory/v2/schemas/{type}`  `GET https://trial.onetrust.com/api/inventory/v2/schemas/processing-activities`
- [Get List of Data Classifications](https://developer.onetrust.com/onetrust/reference/listalldataclassificationsusingget.md): Use this API to retrieve a list of all existing Data Classifications.  ### Example Request  `GET https://{hostname}/api/inventory/v2/data-classifications`  `GET https://trial.onetrust.com/api/inventory/v2/data-classifications`
- [Get List of Data Elements](https://developer.onetrust.com/onetrust/reference/listalldataelementsusingget.md): Use this API to retrieve the list of all existing Data Elements.   ### Example Request  `GET https://{hostname}/api/inventory/v2/data-elements`  `GET https://trial.onetrust.com/api/inventory/v2/data-elements`
- [Get List of Child Inventories by Root Inventory](https://developer.onetrust.com/onetrust/reference/gethierarchyforinventoryidusingget.md): Use this API to provide a paginated list of Child Inventories for a given Inventory Schema Type and a Root Inventory Id.
- [Add Asset Inventory as Child to Parent Inventory](https://developer.onetrust.com/onetrust/reference/linkassetinventorytoparentassetidusingpost.md): Use this API to link an existing asset inventory as a child inventory to a parent asset inventory.
- [Add Legal Entity Inventory as Child to Parent Inventory](https://developer.onetrust.com/onetrust/reference/linklegalentityinventorytoparentlegalentityidusingpost.md): Use this API to link an existing legal entity inventory as a child inventory to a parent legal entity inventory.
- [Add Processing Activity Inventory as Child to Parent Inventory](https://developer.onetrust.com/onetrust/reference/linkprocessingactivityinventorytoparentprocessingactivityidusingpost.md): Use this API to link an existing processing activity inventory as a child inventory to a parent processing activity inventory.
- [Add Vendor Inventory as Child to Parent Inventory](https://developer.onetrust.com/onetrust/reference/linkvendorinventorytoparentvendoridusingpost.md): Use this API to link an existing vendor inventory as a child inventory to a parent vendor inventory.
- [Set Inventory as Parent](https://developer.onetrust.com/onetrust/reference/setinventoryasparentinventoryusingput.md): Use this API to set an existing inventory as a Parent inventory.
- [Remove Child Inventory from Root Inventory](https://developer.onetrust.com/onetrust/reference/unlinkchildinventoryfromhierarchyusingdelete.md): Use this API to unlink a Child Inventory from a Root Inventory.
- [Unset Inventory as Parent](https://developer.onetrust.com/onetrust/reference/unsetinventoryasparentinventoryusingput.md): Use this API to unset an existing inventory from being a Parent inventory.
- [Create Control Implementation](https://developer.onetrust.com/onetrust/reference/addcontrolstoinventoryusingpost.md): Use this API to create one or more control implementations on an inventory using the `type` and `id` for the inventory item and the id(s) of the master controls. When the operation is run unsuccessfully, this will return an exception.
- [Link Inventory](https://developer.onetrust.com/onetrust/reference/createrelationsusingpost.md): Use this API to create a bidirectional link between an inventory and one or more other inventories.
- [Delete Inventory Link](https://developer.onetrust.com/onetrust/reference/deleterelationsusingdelete.md): Use this API to permanently delete a link between an inventory and one or more other inventories.
- [Get Inventory Links](https://developer.onetrust.com/onetrust/reference/getinventoryrelationsbyidusingget.md): Use this API to list an existing links between an inventory and one or more other inventories of a given type.
- [Update Advanced Attributes for Personal Data Association](https://developer.onetrust.com/onetrust/reference/updateadvancedattributesforpersonaldataassociationusingput.md): Use this API to update the advanced attributes of a Personal Data Association that is linked to an inventory object.
- [Update Inventory Link](https://developer.onetrust.com/onetrust/reference/updateinventoryassociationusingput.md): Use this API to update a bidirectional link between two inventories.
- [Link Inventory](https://developer.onetrust.com/onetrust/reference/updaterelationsusingput.md): Use this API to create a bidirectional link between an inventory and one or more other inventories.
- [Get List of Inventory Schemas](https://developer.onetrust.com/onetrust/reference/getallschemasusingget.md): Use this API to retrieve the list of schemas.
- [Get Inventory Schema Details](https://developer.onetrust.com/onetrust/reference/getschemadetailsusingfieldname.md): Use this API to retrieve the schema details by field name.
- [Copy Inventory](https://developer.onetrust.com/onetrust/reference/copyinventoryusingpost.md): Use this API to create a copy of an existing inventory.
- [Create Inventory](https://developer.onetrust.com/onetrust/reference/createinventoryusingpost.md): Use this API to create an inventory of a particular type.
- [Delete Inventory](https://developer.onetrust.com/onetrust/reference/deleteinventoryusingdelete.md): Use this API to delete an Inventory record.
- [Get Inventory by External ID](https://developer.onetrust.com/onetrust/reference/getinventorybyexternalidusingget.md): Use this API to retrieve the inventory by external ID.
- [Get Inventory by ID](https://developer.onetrust.com/onetrust/reference/getinventorybyidusingget.md): Use this API to retrieve the details of a specific inventory.
- [Get List of Inventories by Criteria](https://developer.onetrust.com/onetrust/reference/getlistofinventoriesbyfiltercriteriausingpost.md): Use this API to retrieve the list of inventories for a given type by filter criteria.
- [Get List of Inventories](https://developer.onetrust.com/onetrust/reference/getlistofinventoriesusingget.md): Use this API to retrieve a paginated list of inventories for a given type.
- [Update Inventory Status](https://developer.onetrust.com/onetrust/reference/updateinventorystatusbyidusingput.md): Use this API to change the existing status of an inventory.
- [Update Inventory by ID](https://developer.onetrust.com/onetrust/reference/updateinventoryusingput.md): Use this API to update the existing inventory. The body of the update request should contain a single object with fields in the same format as the output of the inventory detail endpoint. Only include the fields that need to be updated.
- [Update Inventory by External ID](https://developer.onetrust.com/onetrust/reference/upsertinventoryusingput.md): Use this API to update the Inventory if already exists or create a new Inventory otherwise.  ### Example Request  `PUT https://{hostname}/api/inventory/v2/inventories/{type}/reference/{externalId}`  `PUT https://trial.onetrust.com/api/inventory/v2/inventories/vendors/reference/43fd3a8d-3f6b-464e-bf43-3f0c6c592442`
- [Create Data Category](https://developer.onetrust.com/onetrust/reference/createdatacategoryusingpost.md): Use this API to to create new Data Categories in Data Mapping Automation module.
- [Create Data Classification](https://developer.onetrust.com/onetrust/reference/createdataclassificationusingpost.md): Use this API to create new Data Mapping Automation-Data Classification.
- [Create Data Element](https://developer.onetrust.com/onetrust/reference/createdataelementusingpost.md): Use this API to create new Data Elements in Data Mapping Automation module.
- [Create Data Subject](https://developer.onetrust.com/onetrust/reference/createdatasubjectusingpost.md): Use this API to create new Data Subject in the Data Mapping Automation Module.
- [Delete Data Category](https://developer.onetrust.com/onetrust/reference/deletedatacategoryusingdelete.md): Use this API to delete Data Categories within the Data Mapping Automation Module of OneTrust. To successfully delete a data category, there must be no data-elements assigned to the data category.
- [Delete Data Classification](https://developer.onetrust.com/onetrust/reference/deletedataclassificationusingdelete.md): Use this API to delete a data category, the Data Classification ID must be provided in the URL path.
- [Delete Data Element](https://developer.onetrust.com/onetrust/reference/deletedataelementusingdelete.md): Use this API to delete a data element.
- [Delete Data Subject](https://developer.onetrust.com/onetrust/reference/deletedatasubjectusingdelete.md): Use this API to delete a data element.
- [Get List of Data Categories](https://developer.onetrust.com/onetrust/reference/getdatacategoriesbypartialnameusingget.md): Use this API to retrieve a list of all existing Data Categories.
- [Get Data Category](https://developer.onetrust.com/onetrust/reference/getdatacategoryusingget.md): Use this API to provide the details of a single Data Category by ID.
- [Get Data Classification](https://developer.onetrust.com/onetrust/reference/getdataclassificationusingget.md): Use this API to retrieve the details of a single Data Classification by ID.
- [Get Data Element](https://developer.onetrust.com/onetrust/reference/getdataelementusingget.md): Use this API to retrieve the details of a single Data Element by ID.
- [Get List of Data Subjects](https://developer.onetrust.com/onetrust/reference/getdatasubjectsbypartialnameusingget.md): Use this API to retrieve the list of all existing Data Subjects.
- [Get Data Subject](https://developer.onetrust.com/onetrust/reference/getdatasubjectusingget.md): Use this API to retrieve the details of a single Data Subject by ID.
- [Add Comment to Request](https://developer.onetrust.com/onetrust/reference/addcommentsusingput.md): Use this API to add a comment to a request.
- [Delete Requests](https://developer.onetrust.com/onetrust/reference/bulkdeleteusingput.md): Use this API to delete requests in bulk. The associated subtasks, attachments, and Results Summaries will also be deleted. Request deletion is a permanent action that should be exercised with caution.
- [Create Request](https://developer.onetrust.com/onetrust/reference/createrequestqueuefrommessageusingpost.md): > ❗️ End of Support Notification > > As of March 3, 2022, this API is now deprecated. Any customers leveraging this API are encouraged to migrate to the [Create Request API](https://developer.onetrust.com/onetrust/reference/createrequestqueuev2usingpost). For more information, see [OneTrust API Sunsetting & Deprecation Guidelines](https://developer.onetrust.com/onetrust/reference/onetrust-api-sunsetting-deprecation-guidelines).  Use this API to create a request for a given hosted web form. The webform must already be created.
- [Create Request](https://developer.onetrust.com/onetrust/reference/createrequestqueuev2usingpost.md): Use this API to create a new request for the specified web form.  > 🗒 Things to Know > > - Visibility rules configured for the web form associated to the specified template will not be inherited after request creation. For more information, see [Configuring Dynamic Fields with Visibility Rules](https://my.onetrust.com/s/article/UUID-65f49274-b310-d0ef-397c-1d186871d920).
- [Get List of Requests](https://developer.onetrust.com/onetrust/reference/getallrequestqueuesv2usingget.md): Use this API to retrieve a list of all requests. The response will include details for each request along with the approver, date created, and data subject's first and last name.
- [Get Deletion Certificate](https://developer.onetrust.com/onetrust/reference/getdeletioncertificateusingget.md): Use this API to retrieve a deletion certificate for a deleted request. The response will serve as the deletion certification and will include details such as the retention policy (if applicable), deletion date and time, and deletion mode.  > 🗒 Things to Know > > - Certificate data is available only for requests deleted within the past 360 days.
- [Get Request](https://developer.onetrust.com/onetrust/reference/getrequestbyidusingget.md): Use this API to retrieve a single request by its unique identifier along with the associated approver details, date created, and data subject's first and last name.
- [Get Request Creation Logs](https://developer.onetrust.com/onetrust/reference/getrequestcreationlogsusingget.md): Use this API to retrieve the creation details of a request by trace ID. The response will return the created date, creation status, and request ID.  > 👍 > > For more information, see [Using the Asynchronous Request Creation API](https://my.onetrust.com/s/article/UUID-c35a2967-4869-e091-b957-f3819f20d55e?topicId=0TO1Q000000ItSgWAK).
- [Get Request Audit History](https://developer.onetrust.com/onetrust/reference/getrequesthistory.md): Use this API to retrieve the audit history of a request. The response will include details such as field updates and the date and time when changes were made.
- [Get Request Audit History](https://developer.onetrust.com/onetrust/reference/getrequesthistorybyidusingget.md): Use this API to retrieve the audit history of a request. The response will include details such as field updates and the date and time when changes were made.
- [Link Requests](https://developer.onetrust.com/onetrust/reference/linkrequestsusingput.md): Use this API to link or unlink an existing request to one or multiple related requests.
- [Update Request Stage](https://developer.onetrust.com/onetrust/reference/movestatusbyrequestrefidusingput.md): Use this API to update the workflow stage for a specific request.  > 🗒 Things to Know > > - The following system default statuses can be passed as parameter values in the request when moving to a different stage: `NEW`, `VERIFYING_IDENTITY`, `IN_PROGRESS`, `REJECTED`, and `COMPLETE`. > - The `resolutionTitle`, `comments`, and `isInternalComment` parameters are only used when the `nextStage` parameter is set to `REJECTED`. > - You will not be able to advance the request to the next stage if the current stage has required subtasks that have not been completed.  > 👍  >  > For more information, see [Processing a Request](https://my.onetrust.com/s/article/UUID-f24b0959-dd7b-12f1-a475-7e2bd21292bb), [Closing a Request](https://my.onetrust.com/s/article/UUID-557ba7c1-1821-1e6a-9b8d-f846bcfb4515), and [Rejecting a Request](https://my.onetrust.com/s/article/UUID-347ac5f3-9b3f-7cbd-3b9c-36a9251e0e47).
- [Pause Request Deadline](https://developer.onetrust.com/onetrust/reference/pauseorresumedeadlineusingput.md): Use this API to pause the deadline of a request.  > 🗒 Things to Know >  > - The deadline will be removed from the request until it is resumed. Once resumed, it will be adjusted based on the time that the deadline was paused. > - The request will be automatically resumed when the data subject responds. Manually resuming is also supported.  > 👍  >  > For more information, see [Pausing and Resuming a Request Deadline](https://my.onetrust.com/s/article/UUID-33144cf2-8696-e58b-20b2-9c87bb2a17db).
- [Search Requests](https://developer.onetrust.com/onetrust/reference/searchforrequestusingpost.md): Use this API to search for requests by key terms, such as the data subject’s first name, last name, email address, or request ID.
- [Update Request Custom Fields](https://developer.onetrust.com/onetrust/reference/updatecustomfieldsusingput.md): Use this API to update the fields of a request.
- [Create Resolution](https://developer.onetrust.com/onetrust/reference/addnewresolutionusingpost.md): Use this API to create a new resolution.
- [Delete Resolution](https://developer.onetrust.com/onetrust/reference/deleteresolutionusingdelete.md): Use this API to delete an existing resolution.
- [Get List of Resolutions](https://developer.onetrust.com/onetrust/reference/getallv2resolutionsusingget.md): Use this API to retrieve a list of all request resolutions. The response will include details for each resolution along with the corresponding ID, type, and translations.
- [Update Resolution](https://developer.onetrust.com/onetrust/reference/updateresolutionusingput.md): Use this API to update an existing resolution.
- [Share Results Summary](https://developer.onetrust.com/onetrust/reference/shareresultssummaryusingpost.md): Use this API to share data discovery results summary with the data subject via email. The API supports sharing results in CSV or PDF format. When sharing as PDF, you must provide a report template ID to customize the output format.  > 🗒 Things to Know > > - The report template ID (not name) must be provided for PDF reports. > - The API processes sharing asynchronously. For tracking, you can either mark a specific subtask as complete\n by providing the subtaskId (the request will auto-progress when the subtask is completed), or you can mark the entire request as complete using the markRequestAsComplete flag. > - Comments in the request body support HTML content and will be sanitized. > - The report name format is: `{YYYYMMD}_{RequestRefId}___Report` (e.g., `2025113_HMVBKRYTYE___Report`).
- [Add Targeted Data Discovery Details to Subtask](https://developer.onetrust.com/onetrust/reference/adddatadiscoveryusingput.md): Use this API to add Targeted Data Discovery details to a subtask.
- [Complete Subtask](https://developer.onetrust.com/onetrust/reference/completesubtaskusingput.md): Use this API to resolve an existing subtask, marking it as Complete.
- [Add Subtask to Request](https://developer.onetrust.com/onetrust/reference/createsubtaskusingpost.md): Use this API to add a subtask to a request.
- [Get List of Subtasks by Request](https://developer.onetrust.com/onetrust/reference/getallsubtaskbyrefidusingget.md): Use this API to retrieve a list of all subtasks associated with a specific request. The response will include details for each subtask along with the request approver, date created, and deadline.
- [Get List of Subtasks by Criteria](https://developer.onetrust.com/onetrust/reference/getallsubtasksv3usingpost.md): Use this API to retrieve a list of all subtasks by filter criteria.
- [Get Subtask](https://developer.onetrust.com/onetrust/reference/getsubtaskbyidusingget.md): Use this API to retrieve a single subtask by its unique identifier along with the assignee, deadline, and status.
- [Reprocess System Subtask](https://developer.onetrust.com/onetrust/reference/reprocesssubtaskusingput.md): Use this API to reprocess a system subtask.  > 🗒 Things to Know > > - System subtasks in the **Complete** and **Ready for Review** statuses are not supported.
- [Get List of Subtasks](https://developer.onetrust.com/onetrust/reference/subtasksusingget.md): > ❗️ End of Support Notification > > As of January 1, 2026, this API is now deprecated. Any customers leveraging this API are encouraged to use the [Get List of Subtasks by Criteria API](https://developer.onetrust.com/onetrust/reference/getallsubtasksv3usingpost). For more information, see [OneTrust API Sunsetting & Deprecation Guidelines](https://developer.onetrust.com/onetrust/reference/onetrust-api-sunsetting-deprecation-guidelines).  Use this API to retrieve a list of all subtasks. The response will include details for each subtask along with the request approver, created date, and deadline.  > 🗒 Things to Know >  > - This API does not return subtasks in **Complete** status.
- [Update Subtask Status](https://developer.onetrust.com/onetrust/reference/updatesubtaskstatususingput.md): Use this API to update the status of an existing subtask.  > 🗒 Things to Know > > - The following statuses can be passed as parameter values in the request: `IN_PROGRESS`, `FAILED`, `COMPLETED`, and `REJECTED`. > - The Resolution ID can only be passed if the subtask status is updated to `COMPLETED` or `REJECTED`.
- [Update Subtask](https://developer.onetrust.com/onetrust/reference/updatesubtaskusingput.md): Use this API to update an existing subtask.
- [Add Targeted Data Discovery Results Summary to Request](https://developer.onetrust.com/onetrust/reference/datadiscoveryupdatesusingpost.md): Use this API to add Targeted Data Discovery results to a request.
- [Get Targeted Data Discovery Group](https://developer.onetrust.com/onetrust/reference/getallgroupandattachmentdetailsusingget.md): Use this API to retrieve results for a Targeted Data Discovery group for the specified request.
- [Get List of Targeted Data Discovery Groups](https://developer.onetrust.com/onetrust/reference/getallgroupbyrequestusingget.md): Use this API to retrieve a list of all Targeted Data Discovery groups for the specified request. The response will include details for each group along with the corresponding group ID, name, and order.
- [Add Data Points to Targeted Data Discovery Results Summary](https://developer.onetrust.com/onetrust/reference/unstructureddatadiscoveryupdatesusingpost.md): Use this API to add Targeted Data Discovery results that include unstructured data to a request.
- [Create Verification Method](https://developer.onetrust.com/onetrust/reference/createv2verificationmethodusingpost.md): Use this API to create a new verification method for the specified request.
- [Get Verification Method](https://developer.onetrust.com/onetrust/reference/getallv2verificationmethodsbyidusingget.md): Use this API to retrieve a single verification method by its unique identifier for the specified request.
- [Get List of Verification Methods](https://developer.onetrust.com/onetrust/reference/getallv2verificationmethodsusingget.md): Use this API to retrieve a list of all verification methods for the specified request. The response will include details for each verification method along with the corresponding ID, description, and created date.
- [Update Verification Method](https://developer.onetrust.com/onetrust/reference/updatev2verificationmethodusingput.md): Use this API to update an existing verification method for a request.
- [Update Incident Stage by Type](https://developer.onetrust.com/onetrust/reference/assignstagebyname_1.md): Use this API to update the workflow stage for a specific incident by its unique identifier and workflow type.
- [Update Incident Stage](https://developer.onetrust.com/onetrust/reference/assignstagebyname.md): Use this API to update the workflow stage for a specific incident by its unique identifier.
- [Create Incident](https://developer.onetrust.com/onetrust/reference/createincidentusingpost.md): Use this API to create a new incident in the Incident Register by providing the necessary details in the request body. The response will return the unique identifier (UUID) of the newly created incident.
- [Link Incident to Inventory](https://developer.onetrust.com/onetrust/reference/createinventorylinks.md): Use this API to link an incident with a specific inventory type.
- [Get Incident](https://developer.onetrust.com/onetrust/reference/getincidentdetailbyincidentidusingget.md): Use this API to retrieve a single incident by its unique identifier along with the linked assessments, status, and the associated attributes.
- [Search Incidents](https://developer.onetrust.com/onetrust/reference/searchincidentsusingpost.md): Use this API to search for incidents by key terms and filters.
- [Update Incident](https://developer.onetrust.com/onetrust/reference/updateincidentusingput.md): Use this API to update the details of a specific incident by providing the incident's unique ID in the URL path and the updated information in the request body. The response will return the updated incident information.
- [Delete Audit](https://developer.onetrust.com/onetrust/reference/deleteauditusingdelete.md): Use this API to delete an existing audit and its associated workpapers, tasks, and attachments. Any findings associated with the audit can either be retained or deleted. Audit deletion is a permanent action that should be exercised with caution.
- [Delete Audit Scope](https://developer.onetrust.com/onetrust/reference/deletescopeusingdelete.md): Use this API to delete an existing control or control implementation from the scope of an audit.
- [Get Audit](https://developer.onetrust.com/onetrust/reference/getauditdetailusingget.md): Use this API to retrieve a single audit by its unique identifier.
- [Get List of Audits](https://developer.onetrust.com/onetrust/reference/getauditlistpageusingpost.md): Use this API to retrieve a list of audits by key terms and filters. The response will include details for each audit along with the associated approvers, attributes, and auditors.
- [Create Audit](https://developer.onetrust.com/onetrust/reference/validateandcreateauditusingpost.md): Use this API to create a new audit.
- [Update Audit Scope](https://developer.onetrust.com/onetrust/reference/validateandreassignscopesusingput.md): Use this API to update the scope of an audit.
- [Update Audit](https://developer.onetrust.com/onetrust/reference/validateandupdateauditusingput.md): Use this API to update the approvers, attributes, and auditors of a specific audit.
- [Update Workpaper](https://developer.onetrust.com/onetrust/reference/editworkpaperdetailsusingpost.md): Use this API to update the attributes of a specific workpaper.  > Note: Things to Know >  > - Workpaper assignees must be updated using the [Update Audit Scope](https://developer.onetrust.com/onetrust/reference/validateandreassignscopesusingput) API.
- [Get List of Workpapers](https://developer.onetrust.com/onetrust/reference/getauditworkpaperlistviewusingpost.md): Use this API to retrieve a list of all workpapers by key terms and filters. The response will include details for each workpaper along with the associated audit, findings, and attributes.
- [Get Workpaper Control Details](https://developer.onetrust.com/onetrust/reference/getworkpaperbasicdetailinformationusingget.md): Use this API to retrieve the control details of a specific workpaper.  > Note: Things to Know >  > - Workpaper attributes can be retrieved using the [Get Workpaper Results](https://developer.onetrust.com/onetrust/reference/getworkpaperresultusingget) API.
- [Get Workpaper Results](https://developer.onetrust.com/onetrust/reference/getworkpaperresultusingget.md): Use this API to retrieve the results and the attributes of a specific workpaper.  > Note: Things to Know >  > - Workpaper control details can be retrieved using the [Get Workpaper Control Details](https://developer.onetrust.com/onetrust/reference/getworkpaperbasicdetailinformationusingget) API.
- [Get List of Initiatives](https://developer.onetrust.com/onetrust/reference/findallinitiativesbyfilterusingpost.md): Use this API to retrieve a list of all initiatives or search for initiatives based on the specified criteria.
- [Get Initiative](https://developer.onetrust.com/onetrust/reference/getinitiativeusingget.md): Use this API to retrieve details for a specific initiative. The response will include details such as the created date, workflow, and stage.
- [Update Initiative](https://developer.onetrust.com/onetrust/reference/updateinitiativeusingput.md): Use this API to update details of a specific initiative.
- [Create Document](https://developer.onetrust.com/onetrust/reference/createpolicy.md): Use this API to create a policy, standard, procedure, or privacy notice.
- [Create Document Version](https://developer.onetrust.com/onetrust/reference/createpolicyversions.md): Use this API to create a new version of a policy, standard, or procedure.
- [Get List of Documents](https://developer.onetrust.com/onetrust/reference/getlatestpolicies.md): Use this API to retrieve a list of policies, standards, procedures, or privacy notices by the specified compliance document type.
- [Get Document](https://developer.onetrust.com/onetrust/reference/getpolicy.md): Use this API to retrieve details for the specified policy, standard, procedure, or privacy notice.
- [Get Document Version](https://developer.onetrust.com/onetrust/reference/getpublishedpolicyversion.md): Use this API to retrieve the last published version of a policy, standard, procedure, or privacy notice by the specified date.
- [Add Document Attachments](https://developer.onetrust.com/onetrust/reference/adddocumenttopolicy.md): Use this API to add attachments to a policy, standard, procedure, or privacy notice. Attachments can include supporting files or related resources.
- [Create Issue Relationship](https://developer.onetrust.com/onetrust/reference/createissuerelationshiplinksusingpost.md): Use this API to create a relationship between an issue and related records.
- [Create Issue](https://developer.onetrust.com/onetrust/reference/createissueusingpost.md): Use this API to create an issue.
- [Get List of Issues](https://developer.onetrust.com/onetrust/reference/findallissuesbyfilterusingpost.md): Use this API to retrieve a list of all issues or search for issues based on the specified criteria.
- [Get Attribute Schema](https://developer.onetrust.com/onetrust/reference/getattributesbyschemanameusingget.md): Use this API to retrieve the attribute schema for the specified attribute type.
- [Get Issue Relationships](https://developer.onetrust.com/onetrust/reference/getissuelinksusingget.md): Use this API to retrieve relationship details between an issue and related records.
- [Get Issue Tasks](https://developer.onetrust.com/onetrust/reference/getissuerelatedtasksusingget.md): Use this API to retrieve a list of all tasks for a specific issue.
- [Get Issue](https://developer.onetrust.com/onetrust/reference/getissueusingget.md): Use this API to retrieve details for a specific issue.
- [Modify Issue](https://developer.onetrust.com/onetrust/reference/updateissueusingpatch.md): Use this API to partially update details for a specific issue.
- [Update Issue](https://developer.onetrust.com/onetrust/reference/updateissueusingput.md): Use this API to update all details for a specific issue.  > 🗒 Things to Know > > - The `attributes` parameter must be included in the request body but is not required to have values. If there are no attributes to send, pass an empty object {} in the following manner: "attributes": {}. However, if values exist for an attribute, you must include the values for each of those attribute to ensure the values are retained. Otherwise, they will be overwritten.
- [Attach Files to Control Implementation](https://developer.onetrust.com/onetrust/reference/addattachmentstoimplementationusingpost.md): Use this API to attach a list of files to a specific control implementation.  > 🗒 Things to Know >  > - The files must first be uploaded to the OneTrust application using the [Upload File](https://developer.onetrust.com/onetrust/reference/fileupload) API. The `Id` and `Name` parameter values returned in the [Upload File](https://developer.onetrust.com/onetrust/reference/fileupload) API response are required in the request body for this API.
- [Search Control Implementation Attributes](https://developer.onetrust.com/onetrust/reference/findallcontrolimplementationsattributesandoptionsbyusingpost.md): Use this API to search for control implementation attributes by key terms and filters.
- [Get List of Control Implementations](https://developer.onetrust.com/onetrust/reference/findallcontrolimplementationsusingpost.md): Use this API to retrieve a list of all control implementations. The response will include relevant details for each control implementation, including framework and category details and associated attributes.
- [Get List of Control Implementations by Entity](https://developer.onetrust.com/onetrust/reference/findassociatedcontrolimplementationsusingpost.md): Use this API to retrieve a list of all control implementations by entity, such as by assets, processing activities, legal entities, risks, and vendors.
- [Get Control Implementation](https://developer.onetrust.com/onetrust/reference/getcontrolimplementationdetailsusingget.md): Use this API to retrieve a single control implementation by its unique identifier along with the associated attributes, category, and framework details.
- [Delete Control Implementation](https://developer.onetrust.com/onetrust/reference/removecontrolimplementationbyentityandimplementationidusingdelete.md): Use this API to delete a control implementation from an entity.
- [Update Control Implementation](https://developer.onetrust.com/onetrust/reference/updatecontrolimplementationbyimplementationidusingput.md): Use this API to update the attributes of a specific control implementation.  > 🗒 Things to Know >  > - The [Update Control](https://developer.onetrust.com/onetrust/reference/updatecontrolusingput_1) API can be used to update the attributes of a control in the Controls Library.
- [Link Controls](https://developer.onetrust.com/onetrust/reference/bulkcreatelinksusingpost.md): Use this API to link an existing control to one or multiple related controls in the Controls Library.
- [Create Control](https://developer.onetrust.com/onetrust/reference/addcontrolusingpost.md): Use this API to create a new control in the Controls Library.
- [Get List of Controls](https://developer.onetrust.com/onetrust/reference/findcontrolsbycriteriausingpost_1.md): Use this API to retrieve a list of all controls by key terms and filters. The response will include relevant details for each control, including framework and category details and associated attributes.
- [Get List of Control Entity Source Types](https://developer.onetrust.com/onetrust/reference/getallenabledcontrolentitytypesusingget.md): Use this API to retrieve a list of all control entity source types.
- [Get Related Control Entity Types](https://developer.onetrust.com/onetrust/reference/getallrelatedcontrolentitytypesusingget.md): Use this API to retrieve a list of related control entity types.
- [Delete Control](https://developer.onetrust.com/onetrust/reference/removecontrolusingdelete_1.md): Use this API to delete an existing control from the Controls Library.
- [Update Control](https://developer.onetrust.com/onetrust/reference/updatecontrolusingput_1.md): Use this API to update the attributes of a specific control in the Controls Library.
- [Get List of Risk Entity Types](https://developer.onetrust.com/onetrust/reference/getallenabledriskentitytypesusingget.md): Use this API to retrieve a list of all entity types from which a risk can be created.
- [Get List of Risk Entity Source Types](https://developer.onetrust.com/onetrust/reference/getallenabledsourceentitytypesusingget.md): Use this API to retrieve a list of all entity types that can be automatically assigned as the source of a risk.
- [Add Attachments to Evidence Task Implementation](https://developer.onetrust.com/onetrust/reference/addevidenceimplementationattachment-1.md): Use this API to attach files, a note or a link to a specific Evidence Task Implementation.  > 🗒 Things to Know > > - The files must first be uploaded to the OneTrust application using the [Upload File](https://developer.onetrust.com/onetrust/reference/fileupload) API. The `Id` and `Name` parameter values returned in the [Upload File](https://developer.onetrust.com/onetrust/reference/fileupload) API response are required in the request body for this API.
- [Get List of Evidence Task Implementations](https://developer.onetrust.com/onetrust/reference/findallevidencesbysearchcriteria_1-1.md): Use this API to retrieve a list of all evidence task implementations by entity, such as by assignee, control, and current interval status. The response will include relevant details for each evidence implementation.
- [Get Evidence Task Implementation](https://developer.onetrust.com/onetrust/reference/findevidenceimplementationsbyid_1-1.md): Use this API to retrieve a single evidence implementation by its unique identifier.
- [Approve Risk](https://developer.onetrust.com/onetrust/reference/approveriskusingput.md): Use this API to approve the specified risk.
- [Grant Risk Exception](https://developer.onetrust.com/onetrust/reference/grantriskexceptionusingput.md): Use this API to grant an exception for a risk.
- [Perform Risk Action](https://developer.onetrust.com/onetrust/reference/performriskactionusingput.md): > ❗️ End of Support Notification >  > As of October 24, 2025, this API is now deprecated. For more information, see [OneTrust API Sunsetting & Deprecation Guidelines](https://developer.onetrust.com/onetrust/reference/onetrust-api-sunsetting-deprecation-guidelines).  Use this API to perform an action on the specified risk.  > 👍  >  > For more information, see [About Risk Management Workflows](https://my.onetrust.com/s/article/UUID-ebb5abb3-58f6-0d5e-4ef7-ad7afd3f3b44).
- [Reopen Risk](https://developer.onetrust.com/onetrust/reference/reopenriskusingput.md): Use this API to reopen the specified risk.
- [Request Risk Exception](https://developer.onetrust.com/onetrust/reference/requestriskexceptionusingput.md): Use this API to request an exception for the specified risk.
- [Send Back Risk](https://developer.onetrust.com/onetrust/reference/sendbackriskusingput.md): Use this API to send back the specified risk to obtain additional information.
- [Submit Risk](https://developer.onetrust.com/onetrust/reference/submitriskusingput.md): Use this API to submit the specified risk for approval.
- [Update Risk Stage](https://developer.onetrust.com/onetrust/reference/changeriskstageusingpost.md): Use this API to assign a risk to a stage in a workflow. > 🗒 Things to Know >  > - This API will move the risk to the specified stage in the workflow. > - The risk must be in a valid stage to be moved to the target stage.
- [Create or Update Risk](https://developer.onetrust.com/onetrust/reference/createupdateriskusingput.md): Use this API to create a new risk or update an existing one based on matching attributes. If a risk with matching attributes exists, it will be updated; otherwise, a new risk will be created.
- [Delete Risk](https://developer.onetrust.com/onetrust/reference/deleteriskusingdelete.md): Use this API to delete an existing risk from the Risk Register.
- [Update Risk Approvers](https://developer.onetrust.com/onetrust/reference/updateriskapproversusingput.md): Use this API to update the approvers of a specific risk.  Risks approvers cannot be updated for a risk in the Monitoring stage of default risk workflows.
- [Update Risk Categories](https://developer.onetrust.com/onetrust/reference/updateriskcategoriesusingput.md): Use this API to update the categories of a specific risk.
- [Update Risk Owners](https://developer.onetrust.com/onetrust/reference/updateriskownersusingput.md): Use this API to update the owners of a specific risk.  Risk owners cannot be updated for a risk in the Monitoring stage of default risk workflows.
- [Modify Risk](https://developer.onetrust.com/onetrust/reference/updateriskusingpatch.md): Use this API to partially modify an existing risk in the Risk Register.  > 🗒 Things to Know >  > - The **Managing organization assignment for risks** setting must be enabled in the OneTrust Platform to pass values for the `orgGroupId` parameter using this API. If this setting is disabled, any values passed for the `orgGroupId` parameter will be ignored. This setting can be found on the **Global Settings > Risk, Controls & Evidence > General** screen.
- [Update Risk](https://developer.onetrust.com/onetrust/reference/updateriskusingput.md): Use this API to update an existing risk's details. This endpoint allows you to modify various attributes of a risk, including its name, description, owners, approvers, and other properties.
- [Add Controls to Risk](https://developer.onetrust.com/onetrust/reference/addcontrolstoriskusingpost.md): Adds control implementations to a risk
- [Add Threat to Risk](https://developer.onetrust.com/onetrust/reference/addthreattorisk.md): Use this API to add or replace a threat on a risk. > 🗒 Things to Know >  > - If a threat was previously assigned to the risk, that threat will be replaced with the new specified threat after calling this API.
- [Add Vulnerabilities to Risk](https://developer.onetrust.com/onetrust/reference/addvulnerabilitiestorisk.md): Use this API to add or replace vulnerabilities on a risk. > 🗒 Things to Know >  > - If vulnerabilities were previously assigned to the risk, those vulnerabilities will be replaced with the new specified vulnerabilities after calling this API.
- [Get Risk Template](https://developer.onetrust.com/onetrust/reference/getrisktemplateusingget.md): Use this API to retrieve the details for the specified risk template.  > 🗒 Things to Know > > - The `templateId` can be obtained from the OneTrust application URL when accessing the Template Details screen for a risk template.
- [Create Risk](https://developer.onetrust.com/onetrust/reference/createriskusingpost.md): Use this API to create a new risk in the Risk Register. The response will include details of the created risk. > 🗒 Things to Know >  > - This API will create a new risk with the specified details. > - The risk will be created in the default state.
- [Create Risk](https://developer.onetrust.com/onetrust/reference/createstandaloneriskusingpost.md): Use this API to create a new risk in the Risk Register. The response will include details of the created risk. > 🗒 Things to Know > > - This API will create a new risk with the specified details. > - The risk will be created in the default state. > - This is a standalone risk creation endpoint.
- [Get List of Risk Categories](https://developer.onetrust.com/onetrust/reference/getactivecategoriesusingget.md): Use this API to retrieve a list of all risk categories. The response will include details for each risk category along with the corresponding category ID, name, and description. > 🗒 Things to Know >  > - This API will return all active risk categories. > - Each category will include its ID, name, and description.
- [Get List of Linked Risks](https://developer.onetrust.com/onetrust/reference/getlinkedrisksinformationusingpost.md): Use this API to retrieve risks linked to a specific entity type and ID.
- [Get Risk Matrix Configuration](https://developer.onetrust.com/onetrust/reference/getmatrixscoresettingusingget.md): Use this API to retrieve the risk score matrix configuration. The response will return risk details for all impact levels, scores, and probability levels.
- [Get List of Risks](https://developer.onetrust.com/onetrust/reference/getriskpageviewusingpost.md): Use this API to retrieve a paginated list of risks based on search criteria and sorting options.
- [Get Risk](https://developer.onetrust.com/onetrust/reference/getriskusingget.md): Use this API to retrieve details of a specific risk by its unique identifier. The response includes comprehensive information about the risk, including its status, owners, approvers, and other attributes.
- [Get Standard Risk Configuration](https://developer.onetrust.com/onetrust/reference/getstandardscoresettingusingget.md): Use this API to retrieve the standard risk score configuration. The response will return all risk levels along with the corresponding ID, name, and minimum and maximum scores.
- [Unlink Risks](https://developer.onetrust.com/onetrust/reference/unlinkrisksfromentityusingpost.md): Use this API to disassociate one or more risks from a target entity.  > 🗒 Things to Know > > - This operation removes the association between the specified risks and the target entity. > - The risks themselves are not deleted, only the linkage is removed. > - Multiple risks can be unlinked in a single request.
- [Create Multiple Threats](https://developer.onetrust.com/onetrust/reference/addthreatsusingpost.md): Use this API to create multiple new threats in the Threat Library.
- [Create Threat](https://developer.onetrust.com/onetrust/reference/addthreatusingpost_1.md): Use this API to create a new threat in the Threat Library.
- [Get List of Threats](https://developer.onetrust.com/onetrust/reference/findthreatsbycriteriausingpost.md): Use this API to retrieve a list of all threats by key terms and filters. The response will include details for each threat along with the associated category and framework details and its corresponding status.
- [Delete Threat](https://developer.onetrust.com/onetrust/reference/removethreatusingdelete.md): Use this API to delete an existing threat from the Threat Library.
- [Update Threats](https://developer.onetrust.com/onetrust/reference/updatethreatsusingput.md): Use this API to update the attributes of threats in the Threat Library.  > 🗒 Things to Know > > - The [Get List of Threats](https://developer.onetrust.com/onetrust/reference/findthreatsbycriteriausingpost) API can be used to retrieve a list of all existing threats.
- [Create Multiple Vulnerabilities](https://developer.onetrust.com/onetrust/reference/addvulnerabilitiesusingpost.md): Use this API to create multiple new vulnerabilities in the Vulnerability Library.
- [Create Vulnerability](https://developer.onetrust.com/onetrust/reference/addvulnerabilityusingpost_1.md): Use this API to create a new vulnerability in the Vulnerability Library.
- [Get List of Vulnerabilities](https://developer.onetrust.com/onetrust/reference/findvulnerabilitiesbycriteriausingpost.md): Use this API to retrieve a list of all vulnerabilities by key terms and filters. The response will include details for each vulnerability along with the associated category and framework details and its corresponding status.
- [Delete Vulnerability](https://developer.onetrust.com/onetrust/reference/removevulnerabilityusingdelete.md): Use this API to delete an existing vulnerability from the Vulnerability Library.
- [Update Vulnerabilities](https://developer.onetrust.com/onetrust/reference/updatevulnerabilitiesusingput.md): Use this API to update the attributes of vulnerabilities in the Vulnerability Library.  > 🗒 Things to Know > > - The [Get List of Vulnerabilities](https://developer.onetrust.com/onetrust/reference/findvulnerabilitiesbycriteriausingpost) API can be used to retrieve a list of all existing vulnerabilities.
- [Enroll Users to Course](https://developer.onetrust.com/onetrust/reference/enrolluserstocourseusingpost.md): > ❗️ End of Support Notification >  > As of December 5, 2025, this API is now deprecated. For more information, see [OneTrust API Sunsetting & Deprecation Guidelines](https://developer.onetrust.com/onetrust/reference/onetrust-api-sunsetting-deprecation-guidelines).   Use this API to enroll users into a specific course.   > 🗒 Things to Know > > - Any number of users can be enrolled into the specified course per each API call.
- [Get Enrollment Details](https://developer.onetrust.com/onetrust/reference/getenrollmentdetailsusingpost.md): > ❗️ End of Support Notification >  > As of December 5, 2025, this API is now deprecated. For more information, see [OneTrust API Sunsetting & Deprecation Guidelines](https://developer.onetrust.com/onetrust/reference/onetrust-api-sunsetting-deprecation-guidelines).   Use this API to retrieve enrollment records for all courses.  > 🗒 Things to Know >  > The following are examples of available filters that can be applied: >  > <details> >  > <summary><b>Available Filters</b></summary> >  > #### Organization: >  > [{"field":"organization","operator":"=","value":”00000000-0000-0000-0000-000000000000"}] >  > #### Assignee ID: >  > \[{"field":"assigneeId","operator":"=","value":["00000000-0000-0000-0000-000000000000"]}]   > \[{"field":"assigneeId","operator":"=","value":["00000000-0000-0000-0000-000000000001","00000000-0000-0000-0000-000000000002"]}] >  > #### Assigned Date: >  > [{"field":"assignedDate","operator":"BW","value":"yyyy-mm-ddT00:00:00.000Z","toValue":"yyyy-mm-ddT00:00:00.000Z"}] >  > #### Status: >  > \[{"field":"status","operator":"=","value":["NOT_STARTED"]}]   > \[{"field":"status","operator":"=","value":["NOT_STARTED","COMPLETED"]}]   > Available status values: ["NOT_STARTED","IN_PROGRESS","INCOMPLETE","COMPLETED"] >  > #### Score: >  > [{"field":"score","operator":"BW","value":"00","toValue":"100"}] >  > #### Language ID: >  > \[{"field":"languageId","operator":"=","value":["00000000-0000-0000-0000-000000000000"]}] >  > #### Deadline: >  > [{"field":"deadline","operator":"BW","value":"yyyy-mm-ddT00:00:00.000Z","toValue":"yyyy-mm-ddT00:00:00.000Z"}] >  > #### Completed Date: >  > [{"field":"completedDate","operator":"BW","value":"yyyy-mm-ddT00:00:00.000Z","toValue":"yyyy-mm-ddT00:00:00.000Z"}] >  > #### Course ID: >  > \[{"field":"courseId","operator":"=","value":["00000000-0000-0000-0000-000000000000"]}] >  > #### Multiple Filters: >  > \[ {"field":"courseId","operator":"=","value":["00000000-0000-0000-0000-000000000000"],"additionalInformation":null},   > {"field":"status","operator":"=","value":["NOT_STARTED"],"additionalInformation":null} ] >  > </details>
- [Get User's Enrollment Status](https://developer.onetrust.com/onetrust/reference/getstatusofenrollmentusingget.md): > ❗️ End of Support Notification >  > As of December 5, 2025, this API is now deprecated. For more information, see [OneTrust API Sunsetting & Deprecation Guidelines](https://developer.onetrust.com/onetrust/reference/onetrust-api-sunsetting-deprecation-guidelines).   Use this API to retrieve the enrollment status of a user using the `enrollmentAssigneeId` query parameter.
- [Get List of Courses](https://developer.onetrust.com/onetrust/reference/listofcoursesusingget.md): > ❗️ End of Support Notification >  > As of December 5, 2025, this API is now deprecated. For more information, see [OneTrust API Sunsetting & Deprecation Guidelines](https://developer.onetrust.com/onetrust/reference/onetrust-api-sunsetting-deprecation-guidelines).   Use this API to retrieve a list of all courses with basic course details.  > 🗒 Things to Know > > - The `searchText` query parameter can be used to search for courses by title based on keywords. For example, `searchText=privacy` or `searchText=data%20protection`.
- [Unenroll User from Course](https://developer.onetrust.com/onetrust/reference/unenrolluserusingdelete.md): > ❗️ End of Support Notification >  > As of December 5, 2025, this API is now deprecated. For more information, see [OneTrust API Sunsetting & Deprecation Guidelines](https://developer.onetrust.com/onetrust/reference/onetrust-api-sunsetting-deprecation-guidelines).   Use this API to unenroll a user from a specific course using the `enrollmentAssigneeId`.
- [Create Contract](https://developer.onetrust.com/onetrust/reference/createvendorcontractusingpost.md): Use this API to create a new contract.
- [Get List of Contract Types](https://developer.onetrust.com/onetrust/reference/fetchallcontracttypesusingget.md): Use this API to retrieve a list of all contract types.
- [Get Contract Schema](https://developer.onetrust.com/onetrust/reference/getcontractschemausingget.md): Use this API to retrieve the schema for contract attributes. The response will include details such as the attribute name, ID, and associated options.
- [Get Contract](https://developer.onetrust.com/onetrust/reference/loadvendorcontractbycontractidusingget.md): Use this API to retrieve a single contract by its unique identifier. The response will include details such as the created date, approved date, and corresponding approvers.
- [Delete Contract](https://developer.onetrust.com/onetrust/reference/removevendorcontractusingdelete.md): Use this API to delete an existing contract.
- [Search Contracts](https://developer.onetrust.com/onetrust/reference/searchcontractbyvendorandcriteriausingpost.md): Use this API to search for contracts associated with a specific vendor by key terms and filters.
- [Update Contract](https://developer.onetrust.com/onetrust/reference/updatevendorcontractusingput.md): Use this API to update an existing contract.
- [Create Engagement](https://developer.onetrust.com/onetrust/reference/createengagementusingpost.md): Use this API to create a new engagement.  > 🗒 Things to Know > > - For date and time attributes, the formatting should follow the `YYYY-MM-DDTHH:MM:SSZ` format. > - If the `orgGroupId` parameter is not passed in the request, the engagement will be created with the same organization assigned to the engagement's vendor. If the `orgGroupId` parameter value is invalid, then an invalid organization error will be sent. > - The name of the engagement must be 500 characters or less.
- [Get Engagement Schema](https://developer.onetrust.com/onetrust/reference/getengagementschemausingget.md): Use this API to retrieve the schema for engagement attributes. The response will include details such as the attribute name, ID, and associated options.
- [Get Engagement](https://developer.onetrust.com/onetrust/reference/loadengagementbyengagementidusingget.md): Use this API to retrieve a single engagement by its unique identifier along with the associated vendor, workflow, and attributes.
- [Search Engagements](https://developer.onetrust.com/onetrust/reference/loadengagementusingget.md): Use this API to search for engagements associated with a specific vendor by key terms and filters.
- [Delete Engagement](https://developer.onetrust.com/onetrust/reference/removeengagementusingdelete.md): Use this API to delete an existing engagement.
- [Update Engagement Status](https://developer.onetrust.com/onetrust/reference/updateengagementstatus.md): Use this API to update the status of an existing engagement.
- [Modify Engagement](https://developer.onetrust.com/onetrust/reference/updateengagementusingpatch.md): Use this API to partially update an existing engagement.  > 🗒 Things to Know >  > - For date and time attributes, the formatting should follow the `YYYY-MM-DDTHH:MM:SSZ` format. > - The name of the engagement must be 500 characters or less.
- [Update Engagement](https://developer.onetrust.com/onetrust/reference/updateengagementusingput.md): Use this API to update an existing engagement.  > 🗒 Things to Know >  > - For date and time attributes, the formatting should follow the `YYYY-MM-DDTHH:MM:SSZ` format. > - An engagement's workflow or stage cannot be updated using this API. > - If the `orgGroupId` parameter is not passed in the request, the engagement will be created with the same organization assigned to the engagement's vendor. If the `orgGroupId` parameter value is invalid, then an invalid organization error will be sent. > - The name of the engagement must be 500 characters or less.

## Recipes
- [Building your Own Preference Center UI](https://developer.onetrust.com/onetrust/recipes/building-your-own-preference-center-ui.md)
- [Bulk Deleting Privacy Rights Automation Requests](https://developer.onetrust.com/onetrust/recipes/bulk-deleting-privacy-rights-automation-requests.md)
- [Bulk Export for Data Subjects, Consent Receipts, and Cookie Receipts](https://developer.onetrust.com/onetrust/recipes/bulk-export-for-data-subjects-consent-receipts-and-cookie-receipts.md)
- [Combine Data Subject Records into a Linked Identity Group](https://developer.onetrust.com/onetrust/recipes/combine-data-subject-records-into-a-linked-identity-group.md)
- [Consent Attachments: Upload, Attach, Download & Delete](https://developer.onetrust.com/onetrust/recipes/consent-attachments-upload-attach-download-delete.md)
- [Copy Existing Data Subject Profile to New Data Subject Profile](https://developer.onetrust.com/onetrust/recipes/copy-existing-data-subject-profile-to-new-data-subject-profile.md)
- [Creating a Collection Point and Retrieving Consent](https://developer.onetrust.com/onetrust/recipes/creating-a-collection-point-and-retrieving-consent.md)
- [Generate OAuth Access Token](https://developer.onetrust.com/onetrust/recipes/generate-oauth-access-token.md)
- [Handling API Rate Limiting](https://developer.onetrust.com/onetrust/recipes/handling-api-rate-limiting.md)
- [Import Historical Consent Data to Snowflake](https://developer.onetrust.com/onetrust/recipes/import-historical-consent-data-to-snowflake.md)
- [Launch, Respond, Submit, and Complete an Assessment](https://developer.onetrust.com/onetrust/recipes/launch-respond-submit-and-complete-an-assessment.md)
- [Linking Related Workpapers](https://developer.onetrust.com/onetrust/recipes/linking-related-workpapers.md)
- [Real-Time Consent: Lightweight, Fast, and UI-Ready](https://developer.onetrust.com/onetrust/recipes/real-time-consent-lightweight-fast-and-ui-ready.md)
- [Refresh Page After User Accepts or Saves Cookie Settings](https://developer.onetrust.com/onetrust/recipes/refresh-page-after-user-accepts-or-saves-cookie-settings.md)
- [Retrieve Data Subject Consent for all Members of the Data Subject Group](https://developer.onetrust.com/onetrust/recipes/retrieve-data-subject-consent-for-all-members-of-the-data-subject-group.md)
- [Stream Consent Receipt Import Automation](https://developer.onetrust.com/onetrust/recipes/stream-consent-receipt-import-automation.md)
- [Submit Consent Receipts & Retrieve Transactions](https://developer.onetrust.com/onetrust/recipes/submit-consent-receipts-retrieve-transactions.md)
- [Updating a User's Role & Organization](https://developer.onetrust.com/onetrust/recipes/updating-a-users-role-organization.md)
- [Vendor Data Enrichment and Export](https://developer.onetrust.com/onetrust/recipes/vendor-data-enrichment-and-export.md)

## Changelog
- [🎉 OneTrust 202604.1.0 Released!](https://developer.onetrust.com/onetrust/changelog/onetrust-20260410-released.md)
- [🎉 OneTrust 202603.1.0 Released!](https://developer.onetrust.com/onetrust/changelog/onetrust-20260310-released.md)
- [🎉 OneTrust 202602.1.0 Released!](https://developer.onetrust.com/onetrust/changelog/onetrust-20260210-released.md)
- [🎉 OneTrust 202601.2.0 Released!](https://developer.onetrust.com/onetrust/changelog/onetrust-20260120-released.md)
- [🎉 OneTrust 202601.1.0 Released!](https://developer.onetrust.com/onetrust/changelog/onetrust-20260110-released.md)