OneTrust MCP connector

• Create Create a OneTrust type stage Update the workflow stage for a specific OneTrust incident by entity ID and workflow type. Returns: id, name, description. Required: entity_id, type, nextStageName.
• Create Create a OneTrust AI governance entity Create a new AI Governance entity in OneTrust (Models, Datasets, AI Systems, or AI Agents). Returns: id, number, name, orgGroupId, schemaId, entityType, workflowAndStage, entityDetail, attributes, auditFields. Required: name.
• Search OneTrust AI governance entities search Search AI Governance entities in OneTrust by full-text query and filters. Returns a paginated list of entities, each with id, number, name, orgGroupId, schemaId, entityType, entityDetail, attributes, and auditFields. Supports Models, Datasets, AI Systems, and AI Agents.
• Get Get single OneTrust AI governance entity by ID Get a single AI Governance entity in OneTrust by id. Returns: id, example, name. Required: id.
• Update Update a OneTrust AI governance entity by ID Partially update an existing AI Governance entity in OneTrust. Returns: id, number, name, schemaId, entityType. Required: id.
• Delete Delete a OneTrust AI governance entity by ID Delete an AI Governance entity in OneTrust by id. Returns an empty 204 response on success. Required: id.
• Search OneTrust AI governance entity basic details search Search OneTrust AI Governance entity basic details by key terms and filters. Supports AI Governance entities (Models, Datasets, AI Systems, AI Agents). Returns: id, name, in, schema. Max 50 records per page.
• Search OneTrust AI governance entity types search Search OneTrust AI Governance entity types by full-text terms and structured filters. Returns: id, name, nameKey, description, descriptionKey, enabled, seeded, moduleName, schemaName, moduleScopes, workflowType, settings, auditFields. Supports Models, Datasets, AI Systems, and AI Agents only.
• Get Get single OneTrust AI governance entity type by ID Get a single OneTrust AI Governance entity type by id. Returns: id, name, nameKey, description, descriptionKey, enabled, seeded, moduleName, schemaName, moduleScopes, workflowType, settings, auditFields. Required: id.
• Get Get single OneTrust links page by ID List relationship records (links) for a OneTrust AI Governance entity by entity type and id. Returns: content, name, in, schema. Required: entity_type_name, entity_id. Only supports AI Governance entities (Models, Datasets, AI Systems, AI Agents). Max 50 records per page.
• Create Create a OneTrust AI governance link Create a new relationship record between two OneTrust AI Governance entities (Models, Datasets, AI Systems, or AI Agents). Returns the created link including id, linkType, linkTypeLabel, entity1, entity2, schemaId, and auditFields. Required: linkTypeId, entity1, entity2.
• Get Get single OneTrust AI governance link by ID Get a specific relationship record between OneTrust AI Governance entities by id. Returns the link including id, linkType, linkTypeLabel, entity1, entity2, schemaId, and auditFields. Required: id, linkTypeId.
• Delete Delete a OneTrust AI governance link by ID Remove an existing relationship record between OneTrust AI Governance entities by id. Returns an empty 204 response on success. Required: id, linkTypeId.
• Create Create a OneTrust AI governance schema attribute option Add options to an AI Governance attribute in OneTrust. Returns the updated attribute including id, name, nameKey, options, responseType, enabled, createdBy, createdTime, and lastModifiedTime. Required: attributeId and a body array of option/optionKey pairs. Only supports AI Governance entities (Models, Datasets, AI Systems, and AI Agents).
• Create Create a OneTrust AI governance schema attribute Add an attribute to a specific AI Governance schema in OneTrust. Returns the created attribute object including id, name, responseType, enabled, schemaId, schemaName, fieldName, and options (for select-type attributes). Required: schemaName, name, responseType.
• Update OneTrust AI governance schema attributes update enable Enable an AI Governance schema attribute in OneTrust. Returns the updated attribute object including id, name, enabled (set to true), responseType, schemaId, schemaName, and fieldName. Required: attribute_id, schemaId.
• Update OneTrust AI governance schema attributes bulk update Disable an AI Governance schema attribute in OneTrust. Returns the updated attribute object including id, name, enabled (set to false), responseType, schemaId, schemaName, and fieldName. Required: attribute_id, schemaId.
• Create Create a OneTrust AI governance task Create a new task for an AI Governance entity in OneTrust. Returns: id, parentEntityId, taskName, deadline, priority, description, orgGroupId, assigneeId. Required: parentEntityId, taskName, orgGroupId, taskTypeNameKey. Only AI Governance entities (Models, Datasets, AI Systems, and AI Agents) are supported.
• Get Get single OneTrust AI governance task by ID Get a specific OneTrust AI Governance task by id. Returns: id, description, example. Required: id.
• Update Update a OneTrust AI governance task by ID Update an existing task for an AI Governance entity in OneTrust by id. Returns: id, taskName, deadline, status, priority, description, assigneeId, example. Required: id.
• List List all OneTrust audits event types List OneTrust audit event types for which user and system activity are tracked, optionally filtered by product area (module) or record type (object type). Returns: name.
• List List all OneTrust preferences List all consent preferences for a OneTrust data subject by identifier. Returns: preferences (each with consentDate, status, purposeVersion, topics, customPreferences, and geolocation), syncGroups, latestGeoLocation, and dataElements. Required: identifier. The response does not reflect updates made via the Preference Center update API.
• List List all OneTrust cmp banners Retrieve OneTrust CMP banner interface attributes for rendering on the consent banner. Returns: errors, warnings, appConfig, bannerUIData. Required: OT-CDN-Location, OT-App-Id, OT-Device-Type, OT-SDK-Version.
• Create Create a OneTrust cmp dsar Submit a global opt-out Data Subject Access Request (DSAR) on behalf of a data subject in OneTrust. Returns: storageKeys, otConsentString, response, errors, and warnings. Required: globalOptOut with identifier and purposes.
• List List all OneTrust cmp preferences Get OneTrust Consent Management Platform (CMP) Preference Center interface attributes for rendering the consent preference UI on mobile or CTV devices. Returns: errors, warnings, appConfig, pcUIData.
• Create Create a OneTrust cmp save log consent Log consent in OneTrust when a user interacts with a Banner or Preference Center. Returns: receipt, appConfig, errors, warnings. Required: interactionType.
• List List all OneTrust cmp uc purposes Retrieve the required interface attributes to be rendered for OneTrust Universal Consent Purposes. Returns: errors, warnings, ucPurposesData, storageKeys.
• List List all OneTrust cmp vendors List active IAB and Google vendors in OneTrust for display on the Preference Center. Returns: appConfig (showBanner, templateType, bannerReason), iab2V2Vendors (vendors, purposes, specialPurposes, features, specialFeatures), and errors/warnings arrays.
• Create Create a OneTrust consentreceipt Create consent receipts from a collection point in OneTrust to store data subject consent transactions. Returns: receipt (a JWT containing the transaction record), instantLinkToken, and linkToken. Once test is set to true it cannot be reverted to false. OneTrust recommends no more than 10 purposes per receipt (absolute max 20).
• Create OneTrust consentreceipts bulk create Bulk create consent receipts in OneTrust for processing large volumes of consent transactions simultaneously. Returns an array of receipt objects, each containing receipt (JWT transaction record), instantLinkToken, and linkToken. Required: request body with consent receipt data and a valid collection point JWT. Max 20 purposes per receipt.
• Create Create a OneTrust consentreceipts identified Create consent receipts for identified data subjects in OneTrust using non-cookie collection points. Returns an array of created consent receipt objects including their id. Required: identifier. OneTrust recommends no more than 10 purposes per receipt with an absolute maximum of 20.
• List List all OneTrust script integration downloadscriptv 2 s Download OneTrust cookie manager script files for a specified domain. Returns a binary ZIP file download of the domain's script files in blob format. Required: domain_id. The domain must be in Published status.
• List List all OneTrust websites List all websites in the OneTrust cookie scanner including scan status, cookie statistics, and scheduling details. Returns: Id, Url. Use page and size parameters when domains exceed 1,000.
• Create Create a OneTrust website Add one or more websites to the OneTrust cookie scanner by submitting an array of domains and their details. Returns: Id, Url. Required: externalOrgId.
• List List all OneTrust websites scripts Get the OneTrust cookie consent script for a specified website in the Cookie Manager. Returns the script content as a raw string. Required: website.
• Update OneTrust websites publishes bulk update Publish cookie consent script configuration to a website in OneTrust. Returns: autoBlocking, consentPolicyName, publishVersion, publishedDate, reconsentRequired, responseMsg, userName. Required: website.
• Create Create a OneTrust cooky Create a new cookie in OneTrust. Returns the created cookie object including id, name, host, path, source, cookieLifeSpan, httpOnly, secure, length, and durationType. Required: cookieName, lifespan, host, customCategoryName, durationType.
• Update OneTrust cookies bulk update Update an existing cookie in OneTrust. Returns: status, errorMessages. Required: cookieId. For manually created cookies, only cookieName, lifespan, and host are updated.
• Get Get single OneTrust categorize by ID Categorize cookies in OneTrust by cookie name and host for a specified domain. Returns an array of cookie categorization objects including name, type, host, hostDescription, description, category, and domainCount. Required: domain.
• Get Get single OneTrust categorizewithid by ID Categorize OneTrust cookies by domain and cookie ID. Returns an array where each item includes the cookie's pattern (First-Party or Third-Party) and category (Functional, Strictly Necessary, Targeting, Social Media, or Performance). Returns: pattern, category.
• Create Create a OneTrust domain domaingroup Create or update a domain group in OneTrust by submitting a list of URLs for a domain. When removeExisting is false, incoming URLs are appended to the existing group rather than replacing it. Returns an empty response on success. Required: domain_id.
• Search OneTrust cookie reports search Search OneTrust cookie reports by filter criteria such as language, country code, search string, and domains. Returns a paginated list of cookie records including name, type, host, category, description, and domainCount. Use pagination when results exceed 500 cookies.
• Create Create a OneTrust cmp application Create a new application in OneTrust for scan and SDK publishing. Returns the created application object including id, name, and os. Required: name.
• List List all OneTrust cmp applications List applications in OneTrust with optional name filtering and sorting. Returns: id, name, os. Max 100 per page.
• Update OneTrust cmp applications bulk update Publish the SDK script configuration options for a specified application in OneTrust. Returns an empty 200 response on success. Required: application_id.
• Update OneTrust scans bulk update Initiate an application scan in OneTrust by uploading a file. Returns the created scan's scanId. Required: id, file. Maximum file size: 500 MB.
• List List all OneTrust application branding attributes Get branding attributes for a specific OneTrust application. Returns the application's branding attributes object. Required: application_id.
• Update OneTrust application branding attributes bulk update Update branding attributes for a specific OneTrust application. Returns a branding attributes update confirmation response. Required: id.
• List List all OneTrust application scans List scans for a specific OneTrust application. Returns each scan's id, status, scanDate, and engineVersion. Required: application_id.
• Get Get single OneTrust application scan by ID Get a single OneTrust application scan by id. Returns the scan's id, status, scanDate, and engineVersion. Required: application_id, id.
• List OneTrust application scans list scan permissions List permissions detected during a specific OneTrust application scan. Returns each permission's name, category, status, description, and sensitivity. Required: application_id, scan_id.
• List List all OneTrust scan privacy manifests Get a summary of the iOS privacy manifest analysis for a specific application scan in OneTrust. Returns: editVersion, supportedVersions, totalDataTypeCount, alignedCount, misalignedCount, dataTypes. Required: application_id, scan_id. This endpoint is specific to iOS applications.
• Get Get single OneTrust scan privacy manifest by ID Get detailed mismatch information for a specific data type within an iOS privacy manifest scan in OneTrust. Returns: mismatches. Required: application_id, scan_id, data_type. This endpoint is specific to iOS applications; mismatch categories with no detected issues return an empty array rather than being omitted.
• List List all OneTrust scan sdks List SDKs detected during a specific OneTrust application scan. Returns each SDK's pkgId, name, vendor, defaultCategory, and description. Required: application_id, scan_id.
• Get Get single OneTrust scan sdk by ID Get detailed information about a single SDK detected during a specific OneTrust application scan. Returns the SDK's pkgId, name, vendor, defaultCategory, and description. Required: application_id, scan_id, sdk.
• List List all OneTrust application script details Retrieve script details for a specific OneTrust CMP application by application ID. Returns the application script details object including attributes with script configuration. Required: application_id.
• Get Get single OneTrust cookies categorized by ID Retrieve categorized cookies by domain in OneTrust. Returns an array of cookie objects with name, type, host, hostDescription, description, firstPartyDescription, thirdPartyDescription, patternKey, thirdPartyKey, firstPartyKey, category, and domainCount. Required: domain.
• Update OneTrust domains publishes bulk update Publish the cookie consent script configuration to a specified website in OneTrust. Returns: autoBlocking, consentPolicyName, publishVersion, publishedDate, reconsentRequired, responseMsg, userName. Required: website.
• List List all OneTrust domains scripts Retrieve the CMP script for a specified website in OneTrust. Returns the script content as a plain string. Required: website.
• Delete Delete a OneTrust cmp domain by ID Delete a OneTrust CMP domain by id. Returns an empty 204 response on success. Required: id.
• List List all OneTrust domain script details Get script details for a OneTrust domain by domain id. Returns the domain script details object (DomainScriptDetailsPublicDto) with content-type-specific attributes. Required: domain_id.
• List List all OneTrust domain scripts Download OneTrust script files for a specified domain as a ZIP archive in blob format. Returns a binary application/zip file containing the domain's script files. Required: domain_id. The domain must be in Published status.
• List List all OneTrust domain branding attributes Get branding attributes for a OneTrust domain by domain ID. Returns the domain branding attributes object containing the branding configuration for the specified domain. Required: domain_id.
• Update OneTrust domain branding attributes bulk update Update branding attributes for a specific OneTrust domain. Returns the updated branding attributes response (field set defined upstream by the BrandingAttributesUpdateResponseDTO schema). Required: id.
• List List all OneTrust cmp georulegroups List geolocation rule groups in OneTrust, optionally filtered by name. Returns: geoRuleGroupId, geoRuleGroupName, status, version. Max 100 items per page.
• Get Get single OneTrust cmp georulegroup by ID Get a specific geolocation rule group by id in OneTrust, including details about its rules, regions, consent model, and cookie categories. Returns: geoRuleGroupId, geoRuleGroupName, status, version. Required: id.
• Update OneTrust cmp georulegroups bulk update Assign or unassign multiple domains and/or applications to a specified geolocation rule group in OneTrust. For each domain or application, set the value to true to assign or false to unassign. Returns an empty 200 response on success. Required: geo_rule_group_id.
• List List all OneTrust cmp templates List OneTrust CMP (Cookie Consent) templates with their details. Returns: id. Max 100 items per page.
• Get Get single OneTrust cmp template by ID Get detailed information about a specific OneTrust CMP template by id, including banner setup, preference center setup, and cookie list. Returns: id. Required: id.
• List List all OneTrust cmp webscans List websites in the OneTrust cookie scanner, returning websites in Pending and Completed status for the organization and related child organizations. Returns: Id, Url. Max 100 results per page.
• Create Create a OneTrust cmp webscan Start scans for the specified domains in OneTrust. The request body is a required JSON array of scan website request objects (one per domain, items must be unique). Returns an array of service response objects, one per domain scanned.
• Update OneTrust cmp webscans bulk update Cancel a specific OneTrust CMP web scan by its scan identifier. Returns an empty 200 response on success. Required: scan_id.
• Create Create a OneTrust webscans archive Archive specified OneTrust web scans by supplying a bare JSON array of scan UUIDs. Returns an array of action response objects, each containing the id of the processed scan. Required: body (array of scan UUIDs).
• Create Create a OneTrust webscans cooky Add cookies to OneTrust webscans by submitting a batch of cookie creation requests. Returns an array of action response objects including status, errorMessages, and cookie entity details (id, name, host, cookieLifeSpan). Required: body array items with cookieName, lifespan, host, customCategoryName, and durationType.
• Update OneTrust webscans cookies bulk update Edit existing cookies in OneTrust webscans by submitting a batch of cookie update requests. Returns an array of action response objects with status and errorMessages. Required: body array items each containing cookieId.
• Delete OneTrust webscans cookies bulk delete Delete cookies from OneTrust webscans by the specified cookie ID or filter criteria. Returns an array of action response objects with status and errorMessages. Required: body.
• Create Create a OneTrust domains schedule Schedule website scans for specified domains in OneTrust. Accepts an array of unique DomainScheduleRequest objects and returns an array of EntityActionResponseDto action response objects, one per domain, indicating the scheduling result. Required: body.
• Create Create a OneTrust schedule cancel Cancel scheduled website scans for specified domains in OneTrust. Sends an array of domain schedule UUIDs to cancel and returns an array of action response objects, one per cancelled schedule. Required: body (array of domain schedule UUIDs).
• List List all OneTrust domain scans List scans for a specific OneTrust domain, filterable by scan status, archive status, and date range. Returns: id. Required: domain_id.
• List List all OneTrust scan scandeltas List added or removed cookies detected between the current and previous website scan for a specified domain in OneTrust. Returns the scan delta details including id and attributes with cookie change information. Required: domain_id, scan_id.
• List List all OneTrust scan scanresults List scan results for a specific OneTrust webscan, filtered by entity type (cookies, tags, pages, forms, services, or storage). Returns a paginated list with content, totalElements, and totalPages. Required: domain_id, scan_id, entityType.
• List List all OneTrust scan summaries Get a OneTrust scan result summary for a specific domain and scan, including counts of cookies, tags, forms, and other entities found. Returns a ScanResultSummaryDto object whose attributes contain entity count fields defined upstream. Required: domain_id, scan_id.
• Get Get single OneTrust cookies filter by ID Filter and retrieve a paginated list of OneTrust cookies by specified filter criteria, localized by language. Returns: content. Required: language. Max 100 per page.
• Create Create a OneTrust webscans status Get the status of specified OneTrust web scans by submitting an array of scan UUIDs. Returns an array of scan status response objects.
• Update OneTrust webscan recategorizes bulk update Initiate cookie recategorization for a OneTrust web scan. Returns an empty 200 OK response on success. Required: scan_id.
• List List all OneTrust domaindatas List OneTrust domain data including templates, cookie consent models, and vendor lists for a specified domain. Returns: data containing templates, cookie consent models, and vendor lists. Required: location, domain, lang. The domain must be published in OneTrust Admin Portal before calling.
• List List all OneTrust applicationdatas Get OneTrust SDK configuration for a mobile or OTT application, including templates, cookie consent models, and vendor lists. Returns: attributes (tenant-specific SDK configuration data). Required: location, application, lang, sdkVersion. Mobile App data must be published in the OneTrust tenant before calling.
• List List all OneTrust privacynotices List all privacy notices in OneTrust. Returns: id. Max 50 records per page.
• Get Get single OneTrust privacynotice by ID Get a specific version of a privacy notice in OneTrust by id and date, returning the version most recently published before the specified date. Returns: id. Required: id, date.
• List List all OneTrust privacynotice versions List all versions of a specific privacy notice in OneTrust. Returns: id. Required: privacy_notice_id.
• List List all OneTrust collectionpoint tokens Get the JSON Web Token (JWT) for a OneTrust Collection Point by its guid. The token can be used as the requestInformation parameter value in the Consent Receipts API to pass data subject consent transactions. Returns: token. Required: collectionpoint_guid.
• Create Create a OneTrust consentmanager custom index Trigger creation of a custom search index for data elements in OneTrust. Returns: runId, which can be used to query the index creation status via the Get Index Creation Status API. Each account is limited to only one custom search index.
• List List all OneTrust custom indexe status Get the current creation status of a custom search index in OneTrust. Returns: status, startTime, endTime, errorDetails. Required: run_id.
• List List all OneTrust consentmanager custompreferences List all Purpose Preferences (custom preferences) in OneTrust. Returns: id, name. Max 100 per page.
• Create Create a OneTrust consentmanager custompreference Create a new Purpose Preference (custom preference) in OneTrust. Returns the created preference object including id, name, languages, options, selectionType, createdDate, and lastModifiedDate.
• Update Update a OneTrust consentmanager custompreference by ID Update a specific Purpose Preference (custom preference) in OneTrust by id. Returns the updated preference object including id, name, languages, options, selectionType, createdDate, and lastModifiedDate. Required: id.
• Get Get single OneTrust consentmanager custompreference by ID Get a single Purpose Preference (custom preference) in OneTrust by id. Returns: id, name. Required: id.
• Create Create a OneTrust datasubjects dataelement Create or update a OneTrust data subject's data elements by providing a dataSubjectIdentifier and a list of data elements. Returns: Id. Required: dataSubjectIdentifier, dataElements. The primary identifier cannot be updated; set linked to true and provide or clear value to add, edit, or remove additional identifiers.
• Create Create a OneTrust datasubjects merge Process a pending OneTrust data subject merge request by its ID, consolidating existing Purpose statuses captured across duplicate identifiers into a single data subject profile. Returns a success confirmation string. Required: merge_id.
• Update OneTrust datasubjects merges bulk update Merge duplicate OneTrust data subject records into a primary record, consolidating transactions, profile history, and consent statuses. Data subjects listed in additionalIdentifiers are deleted after being merged into primaryIdentifier; existing transactions convert to the primary identifier and data elements use the most recent value. Returns a success confirmation string. Required:…
• List List all OneTrust datasubjects purposes List purposes for a data subject identifier in OneTrust. Returns: transactionGuid, purposeGuid, purposeVersion, transactionType, consentCreationDate, interactionDate, identifier, expiryDate, topics, customPreferences, attributes, receiptId, collectionPointUUID, autoGenerated, purposeNote, and purposeAttachments. This API is deprecated; use the Get List of Data Subjects API instead. Max 100 items…
• Get Get consentmanager export duplicate datasubject by ID Generate an export of duplicate data subjects in OneTrust. The export is delivered as an .xlsx file to the user identified by userGuid and can be downloaded from the OneTrust application. Returns a success confirmation string. Required: id, userGuid.
• List List all OneTrust consentmanager linktokens List OneTrust consent manager link tokens, optionally filtered by date range or data subject identifier. Returns: id. Default sort is ascending by created date.
• List List all OneTrust datasubjects preferences List a data subject's consent preferences within a OneTrust Preference Center, including the Purposes they interacted with and their current status. Returns: purposeGuid, purposeVersion, transactionType, identifier, consentCreationDate, interactionDate. Required: prefcenter_id.
• Update OneTrust datasubjects preferences bulk update Update a data subject's consent preferences within a OneTrust Preference Center. PascalCase is required for all request body parameters. Returns: purposeGuid, purposeVersion, transactionType, identifier, consentCreationDate, interactionDate. Required: prefcenter_id.
• Delete OneTrust datasubjects preferences bulk delete Withdraw a data subject's consent for all Purposes within a OneTrust Preference Center. Returns: transactionGuid, purposeGuid, identifier, consentCreationDate, transactionType, interactionDate. Required: prefcenter_id. The Notification Opt-Out Purpose is excluded from the withdrawal.
• List List all OneTrust preferencecenter preferences Get the schema of a OneTrust Preference Center, including its settings, languages, and Purposes. Supports Original, Enhanced, and Multi Page Preference Centers. Returns: settings, languages, purposes. Required: prefcenter_id.
• List List all OneTrust consentmanager purposes List OneTrust consent purposes. This API is deprecated; use the Get List of Purpose Versions API instead. Returns: id, name, purposeStatus, purposeType, version, createdDate, lastModifiedDate, publishedDate. Max 100 per page.
• Create Create a OneTrust consentmanager purpose Create a new OneTrust consent purpose. The new purpose is created in Draft status with version 1. Returns: id, name. Required: purpose details in the request body.
• Update Update a OneTrust consentmanager purpose by ID Update an existing OneTrust consent purpose. The purpose must be in Draft status; if it is Active, create a new version first. Returns: id, name. Required: id, purpose details in the request body.
• Create OneTrust consentmanager purposes create subpurpose Create a new version of an existing OneTrust Purpose that is currently in Active status. The new version is created in Draft status while the Active version remains unchanged; edits can then be made via the Update Purpose API and changes become visible once the new version is published. Returns the purpose details including id, name, description, version, purposeStatus, purposeType, createdDate,…
• Update OneTrust consentmanager purposes bulk update Publish a OneTrust Purpose, transitioning it from Draft to Active status. Returns: id, name, description. Required: purpose_id, version. The Purpose must be in Draft status before calling; the previous version is set to Retired upon publish.
• List List all OneTrust purpose datasubjects List data subjects for a specific OneTrust Purpose, including last transaction date, transaction status, and purpose preferences. Returns: identifier, transactionGuid, guid, purposeGuid, transactionType, consentCreationDate, interactionDate. Required: purpose_id.
• Update OneTrust purpose retires bulk update Retire a OneTrust Purpose by setting its retirement/expiry date. Returns the Purpose details object including guid, name, version, purposeStatus, retireOnDate, and description. Required: purpose_id. If the date parameter is omitted, the retirement date defaults to one day in the future.
• List List all OneTrust consentmanager receipt lists List consent receipts for a given data subject in OneTrust. Returns: receipts. Required: identifier. This API is deprecated as of September 1, 2024 — migrate to the Receipts V2 API.
• List List all OneTrust consentmanager receipts List consent receipt details for a data subject in OneTrust, including associated Purposes, Purpose Preferences, attributes, and Collection Point interactions. Returns: receiptId, transactionGuid, purposeGuid, interactionDate, transactionType, identifier, consentCreationDate. Required: identifier. Deprecated as of September 1, 2024; max 50 records per page.
• Get Get single OneTrust consentmanager receipt by ID Get a single consent receipt by id in OneTrust, including the interaction date, Purpose details, and consent statuses. Returns: receiptId, transactionGuid, purposeGuid, interactionDate, transactionType, identifier. Required: id. Deprecated as of September 1, 2024.
• List List all OneTrust scheduled jobs merge requests List scheduled exports of duplicate data subjects in OneTrust. Returns: mergeRequestGuid, mergeRequestName, exportFrequency, exportStatus. Max 100 records per page.
• Create Create a OneTrust scheduled jobs merge request Create a scheduled export of duplicate data subjects in OneTrust. Returns a confirmation string. Once created, use the Generate Export of Duplicate Data Subjects API to retrieve the export file.
• Delete Delete a OneTrust scheduled jobs merge request by ID Delete a scheduled export of duplicate data subjects in OneTrust. Returns an empty response on success. Required: id.
• Get Get single OneTrust scheduled jobs merge request by ID Get a specific scheduled export of duplicate data subjects in OneTrust. Returns: mergeRequestGuid, mergeRequestName, exportFrequency, exportStatus. Required: id.
• Update OneTrust withdraw fordatasubjects bulk update Withdraw consent on behalf of a data subject for a specific Purpose in OneTrust. Returns the transaction result including transactionGuid, purposeGuid, receiptId, transactionType, identifier, consentCreationDate, and interactionDate. Required: withdrawnBy and a request body specifying the purpose to withdraw. The data subject identifier must be provided via the identifier query or header…
• Get Get single OneTrust withdraw purpose by ID Withdraw a data subject's consent for a specific Purpose in OneTrust. Returns: transactionGuid, purposeGuid, purposeVersion, transactionType, identifier, consentCreationDate, interactionDate. Required: id (the Purpose UUID). This API is not designed for synchronous workflows.
• Create Create a OneTrust collectionpoint version Create a new version of an existing OneTrust Collection Point that is currently in Active status. The new version is created in Draft status while the Active version remains unchanged. Returns: id, name, version, status. Required: collection_point_guid.
• List List all OneTrust consentmanager datasubjects List data subjects in OneTrust, sorted by descending last modified date by default. Returns each data subject with Id, Identifier, Language, LastUpdatedDate, CreatedDate, DataElements, and TestDataSubject. This API is not designed for synchronous workflows.
• Search OneTrust consentmanager datasubjects search Search for data subjects in OneTrust by data elements, purpose, or consent status. Returns each matching data subject's Id, Identifier, DataElements, Language, CreatedDate, LastUpdatedDate, and TestDataSubject flag. A request body with search criteria is required.
• List List all OneTrust consentmanager linkedidentitygroups List OneTrust Data Subject Groups (Linked Identity Groups). Returns: id. Max 100 records per page.
• Create Create a OneTrust consentmanager linkedidentitygroup Create a new OneTrust Data Subject Group. Returns: id. Groups must contain at least one primary data subject identifier and two data subjects.
• Get Get single OneTrust consentmanager linkedidentitygroup by ID Get a single Data Subject Group in OneTrust by its unique identifier. Returns the group's ID, group name, and the list of data subjects within its group. Required: id.
• Update Update a OneTrust consentmanager linkedidentitygroup by ID Update a Data Subject Group in OneTrust by id. Returns: id. Required: id. Data Subject Groups must contain at least one primary data subject identifier and two data subjects; to rename, pass a groupName different from the current name.
• Delete Delete a OneTrust consentmanager linkedidentitygroup by ID Delete a Data Subject Group from OneTrust by id. Returns an empty 200 response on success. Required: id.
• List List all OneTrust schemas Get the schema for a specific page within a OneTrust Multi Page Preference Center. Returns: sections, purposes, dataElements describing the page structure. Required: preferencecenterpageid.
• List List all OneTrust consentmanager preferencecenters List all Preference Centers in OneTrust. Returns: id, name. Max 100 records per page.
• List List all OneTrust preferencecenter schemas Get the root schema for a Multi Page Preference Center in OneTrust. Returns the root structure of the Preference Center including settings, languages, and pages. Required: preferencecenterid.
• List List all OneTrust consent consent groups List all OneTrust Consent Groups, optionally filtered by name. Returns: id, name, description, externalName, purposeRules.
• Create Create a OneTrust consent consent group Create a new OneTrust Consent Group by providing a name, description, and optional external name. Returns: id, description. Required: name, description. If externalName is omitted, one is generated automatically.
• Get Get single OneTrust consent consent group by ID Get a single OneTrust Consent Group by id. Returns: id, name, description, externalName, purposeRules. Required: id.
• List List all OneTrust consent groups settings Get OneTrust Consent Group settings containing the Priority Scores assigned to each Purpose Status. A lower Priority Score gives a Purpose Status precedence over one with a higher score; the Effective Status of a Purpose is calculated by comparing scores across the Consent Group hierarchy. Returns: purposeStatusPriorityScores.
• Update OneTrust consent groups settings bulk update Update the Priority Score values for Purpose Statuses in OneTrust Consent Group settings. The updated scores are used to calculate the Effective Status of each Purpose across the Consent Group hierarchy: if there is no Parent Consent Group the Effective Status equals the Enforced Status; otherwise the status with the lower Priority Score is applied. Returns: purposeStatusPriorityScores. Required:…
• Create Create a OneTrust consent group consent group Add Consent Groups as children of a Parent Consent Group in OneTrust. Returns the updated Consent Group including its consentGroupId, name, purposeRules, and child consentGroups. Required: consent_group_guid, consentGroupGuids. The hierarchy supports up to 4 levels; a Parent cannot mix child Consent Groups and data subjects at the same level.
• Delete OneTrust consent group consent groups bulk delete Remove one or more child Consent Groups from a parent Consent Group in OneTrust. Multiple Consent Groups can be removed in a single call by specifying the list of child Consent Group IDs in the request body. Returns an empty 204 response on success. Required: consent_group_guid.
• Create Create a OneTrust consent group data subject Add data subjects as children of a parent consent group in OneTrust. Returns the updated consent group object including its ID, purpose rules, and the list of data subjects and/or consent groups within its hierarchical structure. Required: consent_group_guid. A parent consent group can have either consent groups or data subjects as children at a given hierarchy level, not both.
• Delete OneTrust consent group data subjects bulk delete Remove a single data subject from a OneTrust Parent Consent Group. Only one data subject can be removed per API call. Returns an empty 204 response on success. Required: consent_group_guid, data_subject_guid.
• Create Create a OneTrust consent group purpose rule Add Purpose Rules to a OneTrust Consent Group to override Purpose statuses for data subjects within the group. Each Purpose Rule is comprised of an Enforced Status for a particular Purpose. Returns the updated consent group including consentGroupGuid, name, description, and purposeRules. Required: consent_group_guid.
• Update OneTrust consent group purpose rules bulk update Update existing Purpose Rules within a OneTrust Consent Group. Each Purpose Rule is comprised of an Enforced Status for a particular Purpose. Returns the updated consent group including consentGroupGuid, name, description, and purposeRules. Required: consent_group_guid.
• Delete OneTrust consent group purpose rules bulk delete Remove an existing Purpose Rule from a OneTrust Consent Group by purpose GUID. Returns an empty 204 response on success. Required: consent_group_guid, purpose_guid.
• Delete OneTrust consent datasubject purposes bulk delete Delete a specific purpose from all data subjects in OneTrust for large-scale deletion. Returns a 202 confirmation message string. Required: purpose_guid. Either importID or jobGuid must be supplied in the request body unless deletePurposeFromAllDataSubjects is set to true. Data subject exclusion lists are valid for 30 days after submission.
• List List all OneTrust consent datasubjects List data subjects in OneTrust last updated within a specified date range. Returns: Id. Required: fromDate, toDate. Max date range is 7 days.
• Delete OneTrust consent datasubjects bulk delete Delete data subjects permanently in OneTrust by identifiers, identifier GUIDs, or date range. Returns a confirmation message string (e.g., "Deletion Request has been accepted"). Required: a request body specifying one deletion criterion (identifiers, identifier GUIDs, or a date range). Up to 999 identifiers per call; date ranges must be 24 hours or less; created date and interaction date ranges…
• Get Get single OneTrust consent receipt by ID Retrieve a list of consent receipts in OneTrust filtered by collection point, purpose, organization, date range, or data subject identifier. Returns: receiptId, identifier, transactionGuid, purposeGuid, consentCreationDate, interactionDate. The timespan between fromDate and toDate must be 24 hours or less; only receipts from the last 90 days are returned by default.
• Get Get single OneTrust consent transaction by ID List OneTrust consent transactions with optional date range and collection point filters. Returns: transactionGuid, purposeGuid, identifier, consentCreationDate, interactionDate, transactionType, and purpose preferences for each transaction. The timespan between fromDate and toDate must be 24 hours or less.
• List List all OneTrust consent deletion certificates List deletion certificates for a data subject in OneTrust. Returns: Id. Required: identifier. Max 50 results per page.
• Delete OneTrust receipts cross devices bulk delete Delete cross device consents and the related receipts in OneTrust. Returns a confirmation string such as "Request accepted". The request body specifying data subject identifiers is required. A maximum of 1000 data subject identifiers can be deleted per request and requests are processed asynchronously.
• Delete OneTrust consent data subjects bulk delete Delete a data subject in OneTrust by initiating a TTL-based deletion process. Returns a string acknowledgment confirming the deletion request was accepted. Required: identifier, retainReceipts. An additionalIdentifier may be supplied to further qualify the data subject.
• Delete OneTrust data subjects profiles bulk delete Delete specific purposes from data subjects in OneTrust by initiating a TTL-based deletion. Returns a confirmation string indicating the request was accepted. Required: purposes. At least one of identifier or additionalIdentifier must also be provided.
• List List all OneTrust datasubjects basic details Get a OneTrust data subject's basic details by identifier. Returns: Id. Required: identifier.
• List List all OneTrust datasubjects details Get complete details for a specific data subject in OneTrust, including basic details, purpose details, and email link tokens. Returns: basicDetails, purposeDetails, emailLinkTokens. Required: identifier.
• List List all OneTrust datasubjects ds profiles List all purpose details for a specific data subject in OneTrust. Returns: identifier, purposeGuid, transactionType, consentCreationDate, interactionDate, customPreferences. Required: identifier. Supports sorting by lastUpdatedDate; max 50 results per page.
• List List all OneTrust datasubjects linktokens Get the email link token for a specific data subject in OneTrust. Returns: tokenId, expiryDate, createdDate, and the associated data subject identifier. Required: identifier.
• List List all OneTrust profiles unordereds Retrieve an optimized, unordered list of all purpose details for all data subjects in OneTrust, filtered by a mandatory date range. Returns: transactionGuid, purposeGuid, identifier, consentCreationDate, interactionDate, transactionType, receiptId, collectionPointUUID. Required: updatedSince, updatedUntil. Maximum date range is 30 days; results are unsorted and support bookmark-based pagination.…
• Search OneTrust datasubjects search by elements search Search OneTrust data subjects by a specific data element name and value. Returns each matching data subject's Id, Identifier, Language, LastUpdatedDate, CreatedDate, DataElements, and TestDataSubject. Required: dataElementName, dataElementValue.
• List List all OneTrust datasubjects unordereds List unsorted OneTrust data subjects last updated within a specified date range using a high-performance bulk retrieval API. Returns: Id. Required: fromDate, toDate. The maximum date range is 7 days and results are not returned in any specific order.
• List List all OneTrust consent groups List Data Subject Groups in OneTrust. Returns: Id, Name, createdDate. Max 50 results per page.
• Create Create a OneTrust consent job Create a new schedule job for data subject bulk actions in OneTrust. Returns: id, created_at, updated_at. A JSON request body specifying the job configuration is required.
• List List all OneTrust consent linkedidentitygroups List a data subject's Data Subject Group associations in OneTrust. Returns: linkedIdentityGroupId, identifier, addedDate. Required: identifier.
• Create Create a OneTrust consent linkedidentitygroup Create a new Data Subject Group in OneTrust. Returns the created Data Subject Group object including its id, groupName, and associated data subject details. Requires a request body containing at least one primary data subject identifier and two data subjects.
• Update Update a OneTrust consent linkedidentitygroup by ID Update an existing Data Subject Group in OneTrust by id. Returns the updated group with its id, groupName, and data subjects. Required: id. Groups must contain at least one primary data subject identifier and two data subjects; to rename, set groupName to a value different from the current name.
• List OneTrust consent linkedidentitygroups list members List all members of a OneTrust data subject group. Returns: Id, Identifier, Language, LastUpdatedDate, CreatedDate, DataElements, TestDataSubject, addedDate. Required: data_subject_group_id. Max 50 results per page.
• List List all OneTrust consent linktokens List OneTrust data subject link tokens created within a specified date range for all data subjects. Returns: id. Required: fromDate, toDate. The maximum date range is 7 days; max 50 results per page.
• Create Create a OneTrust preferences attachment Upload a consent attachment file to OneTrust for storing written consent of data subjects' transactions. Returns: RefId, which can be used to attach the file to consent receipts. Required: file. Supported formats: .pdf, .jpeg, .jpg, .png; max file size 4MB.
• Get Get single OneTrust preferences attachment by ID Download a consent attachment from OneTrust by id (the RefId returned by the upload endpoint). The response is a binary ZIP file containing the requested attachment. Required: id, identifier.
• Delete Delete a OneTrust preferences attachments reference by ID Remove a specific consent attachment file reference from a data subject in OneTrust. The id corresponds to the RefId from the Upload Attachments API. Returns a 202 Accepted response with schema-specific fields from the ConsentAttachmentReferencesResponse schema. Required: id.
• Delete OneTrust datasubject attachment references bulk delete Remove all consent attachment file references for a given data subject in OneTrust. Returns a 202 Accepted response confirming the deletion request has been accepted for async processing. Required: identifier.
• List List all OneTrust preferences datasubjects Download all consent attachments for a data subject in OneTrust as a ZIP file. Returns: content. Required: identifier.
• List List all OneTrust preferences datasubject profiles List OneTrust data subjects with details about the latest Collection Point update. Returns: Id. Deprecated — prefer the V1 or V4 Data Subjects API instead.
• List List all OneTrust all names Retrieve a list of all business glossary names in OneTrust. Returns: data, an array of glossary name strings.
• List List all OneTrust glossaries names Get a OneTrust business glossary by its name. Returns: id, description. Required: glossary_name.
• List List all OneTrust glossary tag names List all glossary tag names in OneTrust, optionally filtered by tag type. Returns: id, name, type. Optional type filter accepts CATEGORY, CLASSIFICATION, BUSINESS_DOMAIN, RETENTION, or ROT.
• List List all OneTrust tag details Get details for a specific tag in the OneTrust glossary by its name. Returns: id, name, type. Required: name. Example: Resume
• List List all OneTrust glossary terms List all glossary terms in OneTrust, or search for a specific term by name. Returns each term's id, name, glossary, description, type, and tags.
• Create Create a OneTrust glossary term Create a new term in a OneTrust glossary. Returns the created term's id, name, glossary, description, type, and tags. Required: name, glossary.
• List List all OneTrust terms attribute details Get the details of a specific term attribute in OneTrust by its name. Returns: id, name, description, required. Required: name.
• List List all OneTrust terms attribute names List all term attribute names created by internal and external systems in OneTrust. Returns: data — a list of term attribute name strings.
• List List all OneTrust terms names List all glossary term names in OneTrust. Returns an array of term name strings (e.g. URL).
• Get Get single OneTrust terms name by ID Get a specific glossary term by its name in OneTrust. Returns: id, description, type, tags. Required: term_name.
• Create Create a OneTrust glossary tag Create a new tag in the OneTrust Glossary. Returns: id, name, type. Required: type. The type parameter is case-sensitive (e.g., use CATEGORY, not Category).
• Create Create a OneTrust data governance data asset Create or upsert a data asset in OneTrust, maintaining a structured top-down hierarchy. Returns: id. Required: parentId, name, type, dataSource. Except for the root node, every data asset must have its parent record already present before being added.
• Get Get single OneTrust data governance data asset by ID Get a specific data asset by id in OneTrust. Returns the full data asset object including its id, name, type, parentId, dataSource, additionalAttributes, associatedTerms, and associatedTags. Required: id.
• Update Update a OneTrust data governance data asset by ID Modify an existing data asset in OneTrust. The system replaces existing terms, tags, additional attributes, or users with the new data in the request. Returns: id. Required: id.
• Delete Delete a OneTrust data governance data asset by ID Delete a data asset by id in OneTrust. If the data asset has child objects, those are also deleted asynchronously. Returns an empty 202 response on success. Required: id.
• Action OneTrust data governance data assets attach tag Create tag associations for a data asset in OneTrust by assigning a list of tags. Returns: id. Required: data_asset_id, tagId.
• Delete Delete a OneTrust tags delete tag association by ID Delete multiple tag associations from a OneTrust data asset by submitting a list of tags to remove. Returns: id. Required: data_asset_id and a request body array of tag associations to remove.
• Create Create a OneTrust data asset term Create term associations for a specified OneTrust data asset by submitting a list of terms to assign. Returns: dataAssetId. Required: data_asset_id.
• Delete Delete a OneTrust terms delete term association by ID Delete multiple term associations from a specified OneTrust data asset by providing a list of terms to remove. Returns: dataAssetId confirming the updated asset after successful removal. Required: data_asset_id and a body array of term association requests.
• List List all OneTrust metadata attribute details Get a OneTrust data asset attribute by name from the metadata catalog, returning matching attribute information. Returns: id, name, description, required. Required: name.
• List List all OneTrust metadata attribute names List all data asset attribute names from the OneTrust Attribute Manager. Returns: data.
• List List all OneTrust data governance field details List all catalog search fields in OneTrust Data Governance. Returns: fieldName, dataType, operators for each search field. No required parameters.
• List List all OneTrust jobs List pending custom connector scan jobs for a specified data source in OneTrust. Returns an array of JobDetails objects including each job's id. Required: datasourceId.
• Create Create a OneTrust job catalog data Submit catalog data metadata to a OneTrust custom connector scan job for cataloging. Accepts a required MetadataRequests JSON body. Returns an empty 200 response on success. Required: job_id (the custom connector scan job identifier, obtainable via the Get List of Scan Jobs API).
• Create Create a OneTrust job classify data Submit content for classification to a custom connector scan job in OneTrust. Returns a 200 OK response with no response body on success. Required: job_id.
• Update OneTrust job status bulk update Update a custom connector scan job's status in OneTrust. Returns an empty 200 response on success. Required: job_id, status.
• List List all OneTrust discovery scan config credentials List OneTrust discovery scan config credentials with optional filtering by name and systemName. Returns: id, name. Max page size 50.
• Create Create a OneTrust discovery scan config credential Create a new OneTrust discovery scan config credential. Returns: id.
• Get Get single OneTrust discovery scan config credential by ID Get a single OneTrust discovery scan config credential by id. Returns: id, name. Required: id.
• Delete Delete a OneTrust discovery scan config credential by ID Delete an existing OneTrust discovery scan config credential and its associated reference keys by id. Returns an empty 204 response on success. Required: id.
• Update OneTrust discovery scan config credentials bulk update Update an existing OneTrust discovery scan config credential. Returns the updated credential including id, name, systemName, referenceKey, and createdDate. Required: id.
• Create Create a OneTrust discovery scan config scan job Create a new scan job in OneTrust for the specified data source. Returns the created scan job object including id, status, scanLevel, createdDate, cancelledDate, and progress.
• Get Get single OneTrust discovery scan config scan job by ID Get a specific OneTrust discovery scan job by its unique identifier (UUID). Returns comprehensive job information including id, status, scanLevel, createdDate, cancelledDate, and progress. Required: id.
• Update OneTrust discovery scan config scan jobs bulk update Cancel an existing OneTrust discovery scan job by its UUID. The job must be in a cancellable state (PENDING, PROCESSING, or PAUSING); COMPLETED, FAILED, CANCELLED, or CANCELLING jobs cannot be cancelled. Cancellation is asynchronous — status transitions to CANCELLING immediately, then to CANCELLED once acknowledged. Returns: id. Required: job_id.
• Get Get single OneTrust scan job datasource by ID List all scan jobs for a specific data source in OneTrust. Returns: id. Required: id (data source UUID). Max 50 records per page.
• List List all OneTrust discovery scan config scan profiles List OneTrust discovery scan profiles with optional filtering by name, system, scan type, and creation date. Returns: name. Max 50 records per page.
• Create Create a OneTrust discovery scan config scan profile Create a new OneTrust discovery scan profile. Returns: id.
• Get Get single OneTrust discovery scan config scan profile by ID Get a single OneTrust discovery scan profile by id. Returns: name. Required: id.
• Delete Delete a OneTrust discovery scan config scan profile by ID Delete an existing OneTrust discovery scan profile by id. Returns an empty 204 response on success. Required: id.
• Update OneTrust discovery scan config scan profiles bulk update Update an existing OneTrust discovery scan profile. Returns: id.
• List List all OneTrust scanner jobs Get a single scan job for a specific scanner in OneTrust by its unique identifier. Returns: id. Required: scanner_id, job_id.
• Update OneTrust scanner jobs bulk update Cancel an existing scan job in OneTrust. Returns the scan job object including id, status, progress, createdAt, updatedAt, metadataCounts, scanProfile, and ingestionStatus. The 202 Accepted response indicates cancellation was accepted and initiated. Required: scanner_id, job_id.
• List List all OneTrust discovery scan config docker repository tags List Docker image tags for a specific worker node version in OneTrust. Returns a list of image tag name strings in the format [REPOSITORY[:TAG]], where tag stands for version number. Optional: version.
• List List all OneTrust discovery scan config systems List OneTrust data sources (discovery scan config systems) with optional filtering by name, system type, status, creation date range, OneTrust asset, or worker node. Returns: id. Max 50 records per page.
• Get Get single OneTrust discovery scan config system by ID Get a single OneTrust data source (discovery scan config system) by its UUID. Returns the data source object including id, name, systemType, status, createdDate, oneTrustAssetId, workerNodeId, and settings. Required: id.
• Delete Delete a OneTrust discovery scan config system by ID Delete an existing OneTrust data source and its associated scan results by UUID. Returns an empty 204 response on success. Required: id.
• Update OneTrust discovery scan config systems bulk update Create or update a OneTrust data source (discovery scan config system) by upserting the details provided in the request body. Returns: id.
• List List all OneTrust label manager custom classifiers List all custom classifiers in OneTrust Label Manager, optionally filtered by a search keyword or mapped term. Returns: id, name, detectorType.
• Create Create a OneTrust label manager custom classifier Create a custom classifier in OneTrust. Returns a 201 status on success with a Location header containing the URL of the created classifier; no response body is returned. Required: a request body conforming to the CustomDetectorDto schema.
• Get Get single OneTrust label manager custom classifier by ID Get a specific custom classifier in OneTrust by its classifier name. Returns: classifierName, id, detectorType, detectionRules, lastModifiedDate, createdDate. Required: classifier_name.
• Update OneTrust label manager custom classifiers bulk update Update an existing OneTrust custom classifier by name. Accepts a CustomDetectorDto request body with the updated classifier definition. Returns an empty 200 response on success. Required: classifier_name.
• Delete OneTrust label manager custom classifiers bulk delete Delete a custom classifier in OneTrust by its classifier name. Returns an empty 204 response on success. Required: classifier_name.
• List List all OneTrust emission factors List emission factors in OneTrust ESG Management. Returns an array of BasicEntityDetail records, each containing id and name. The returned ids are used to populate the emissionFactorId field when creating emission transactions.
• Create Create a OneTrust emission factors entity Create a new emission factor entity in OneTrust ESG Management. Returns the created emission factor including id, number, name, orgGroupId, entityDetail (with unitOfMeasure, intensity, source, scope, orgGroup), entityType, attributes, and auditFields. Required: name, entityDetail.
• Create Create a OneTrust emission transactions entity Create an emission transaction in OneTrust ESG Management. Returns the created transaction including id, name, orgGroupId, entityDetail with emission factor and activity data, and auditFields. Required: name, orgGroupId, entityDetail (with emissionFactorId in entityDetail.data).
• Create Create a OneTrust entities page Search for OneTrust ESG emission details (emission factors or emission transactions) by filter criteria in the request body. Returns a paginated list with content, totalElements, totalPages. Required: entity_type_name.
• Create Create a OneTrust metrics metric detail Retrieve the latest OneTrust ESG metric details based on a reporting period. Returns: data (a list of metric data aggregate details). Requires either startDate and endDate, or allTimeOption in the request body. This API is deprecated with no replacement.
• List List all OneTrust external organizations List all organizations within the OneTrust organizational hierarchy. Returns: externalId, parentExternalId.
• Create Create a OneTrust external organization Create a new organization in OneTrust's organizational hierarchy. Returns: externalId, parentExternalId. Required: externalId. If parentExternalId is omitted, the organization is created under the root organization.
• Update Update a OneTrust external organization by ID Update the details of an existing organization in OneTrust's organizational hierarchy. Returns an empty 204 response on success. Required: id.
• Delete Delete a OneTrust external organization by ID Delete an existing OneTrust organization and move its associated objects to a target organization. Returns an empty 200 response on success. Required: id, targetExternalId.
• List List all OneTrust access login histories List OneTrust login history audit records for all users or a specific user. Returns: userName, ipAddress, userAgentString, createDT, status, userId. Without a date range or userId, defaults to all users for the past 7 days; with a userId but no date range, defaults to that user for the past 365 days. The date range must fall within the last 365 days or an error is returned.
• Get Get single OneTrust oauth token by ID Generate an OAuth access token in OneTrust using the client_credentials grant type. Returns: access_token, token_type, expires_in, scope, role, ot-scopes, guid, and tenantGuid. Required: grant_type, client_id, client_secret. A maximum of 500 OAuth 2.0 client credentials can be created per account.
• List List all OneTrust user group access levels List access levels (roles) for a specific user group in OneTrust. Returns an array of access level objects representing role-organization assignments, each including its id. Required: group_id.
• Create Create a OneTrust user group access level Add a new role (access level) to a user group in OneTrust. Accepts an access level request specifying a role-organization assignment. Returns a 201 response with no body on success. Required: group_id.
• Update OneTrust user group access levels bulk update Replace all roles for a user group in OneTrust with a new set of role-organization assignments. Returns an empty 204 response on success. Required: group_id.
• Delete OneTrust user group access levels bulk delete Remove roles (access levels) from a specific user group in OneTrust by providing a list of access levels to remove. Returns an empty 204 response on success. Required: group_id.
• List List all OneTrust access users List all users in your OneTrust account. Returns: id, name. Max 2000 records per page.
• Create Create a OneTrust access user Create a new user in your OneTrust account. Returns the identifier of the newly created user.
• Get Get single OneTrust access user by ID Get a single user in OneTrust by id. Returns: id, name. Required: id.
• Update Update a OneTrust access user by ID Update a single user in OneTrust by id. Returns an empty 200 response on success. Required: id.
• List List all OneTrust user access levels List roles (access levels) assigned to a specific OneTrust user. Returns: id. Required: user_id.
• Create Create a OneTrust user access level Add a new role (access level) to a specific OneTrust user. Returns an empty 201 response on success. Required: user_id. The INVITED role cannot be added via this API.
• Delete OneTrust user access levels bulk delete Remove a specific role from a OneTrust user. Returns an empty 204 response on success. Required: user_id, plus a request body identifying the role and organization to remove.
• Update OneTrust user default organizations bulk update Modify the default organization for a specific OneTrust user. Returns an empty 204 response on success. Required: user_id, organizationId. The user must have at least one role in the specified organization.
• List List all OneTrust user activities List audit records for a specific OneTrust user's profile changes, including a history of changes to the user's details, roles, and organizations. Returns: content. Required: user_id.
• List List all OneTrust ot insights bulk export jobs List OneTrust bulk export jobs. Returns each export's id, name, status, createdDate, completedDate, and expiryDate. Sortable by name, status, createdDate, completedDate, or expiryDate. Max 2000 per page. Status auto-expires 10 days after creation.
• Create Create a OneTrust ot insights bulk export job Create a OneTrust bulk export job for consent receipts, cookie receipts, data subjects, or data subjects bulk actions. Returns: id, name. Required: exportType, startDate, endDate. Date span limited to 180 days; max 1 million records; 20 exports per month per account.
• Get Get single OneTrust ot insights bulk export job by ID Get the current status and progress of a OneTrust bulk export job by id. Returns: id, name. Required: id. Status auto-expires 10 days after creation.
• Delete Delete a OneTrust ot insights bulk export job by ID Cancel a OneTrust bulk export job that has not yet completed by id. Returns an empty 200 response on success. Required: id.
• List List all OneTrust bulk export jobs credits Get bulk export credit details for the OneTrust account. Returns: totalCreditsAvailable, creditsRemaining, creditsUsed. Each account is limited to 20 bulk exports per month; cancelled exports that have not completed are not counted toward this limit.
• List List all OneTrust bulk export job downloads Get OneTrust bulk export download details by bulk export job id. Returns an array of download objects each containing token, fileName, and url for retrieving export files. Required: bulk_export_job_id. The authorization token expires after 1 hour and each file has its own unique token.
• List List all OneTrust download pages List paginated download details for a OneTrust bulk export job, returning per-file download information including an authorization token (expires after 1 hour), file name, and download URL for each generated export file. Returns: url. Required: bulk_export_job_id. Max 500 records per page.
• Create Create a OneTrust document attachment Upload a file up to 64MB to the OneTrust Platform document repository. Returns: Id. Required: file, attachment. The file extension must be in one of the supported formats.
• List List all OneTrust contents Get the file location of an uploaded attachment in OneTrust. Returns: downloadUrl. Required: attachment_id.
• Get Get single OneTrust attachments token by ID Get a short-lived download token for an attachment in OneTrust. The token must be presented as a Bearer token to the document-gateway endpoint to download the file content. Returns: token. Required: id.
• Create Create a OneTrust credential Create a new system credential for a specific connector type in OneTrust. Returns an empty 201 response on success. Required: type, and a credential request body conforming to the CredentialsV2Dto schema.
• Update OneTrust credentials bulk update Update details for an existing system credential in OneTrust. Returns an empty 202 response on success. Required: type, name, and a credential request body conforming to the CredentialsV2Dto schema.
• List List all OneTrust workflows exports Export a OneTrust integration workflow as a JSON file containing its full configuration. Returns the workflow definition including its id and workflow-specific attributes. Required: workflowName.
• Create Create a OneTrust workflows import Import an integration workflow in OneTrust from a provided JSON file. Returns the created workflow with its id and configuration attributes. Required: file.
• List List all OneTrust pages List all contextual entity relationships for an Inventory in OneTrust, with optional filtering via the request body. Returns: id, name, createdDate. Required: inventory_id.
• Update OneTrust contextual entity types names bulk update Update a contextual entity relationship by entity type name in OneTrust. Modifies a contextual link between two entities identified by the contextual link id and entity type name. Returns an empty 200 response on success. Required: contextual_link_id, entity_type_name.
• Update OneTrust name data elements bulk update Link or unlink personal data elements to a relationship in OneTrust by entity type name. Accepts an array of data element and data subject type identifier pairs. Returns an empty 201 response on success. Required: contextual_link_id, entity_type_name.
• Update Update contextual entitie contextual entity type by ID Update a contextual link relationship between two entities in OneTrust by entity type ID. Returns an empty 200 response on success. Required: contextual_link_id, id.
• Update OneTrust contextual entity type data elements bulk update Link or unlink personal data elements to a OneTrust relationship by entity type. Accepts a body array of objects each containing dataElementId and dataSubjectTypeId. Returns an empty 201 response on success. Required: contextual_link_id, entity_type_id, dataElementId, dataSubjectTypeId.
• Create Create a OneTrust inventories relation Create a bidirectional link between an inventory and one or more other inventories in OneTrust. Returns a UUID string identifying the created relationship. A JSON request body is required.
• Create Create a OneTrust inventory linking relationship Create a relationship record between inventories (Assets, Vendors, Processing Activities, and Entities) in OneTrust. Returns the UUID of the newly created relationship. Required: a request body specifying the relationship to create.
• List List all OneTrust name relationships Get a OneTrust inventory-linking relationship by relationship type name and relationship id. Returns relationship details created between entities. Returns: id. Required: relationship_type_name, relationship_id.
• Delete Delete a OneTrust name relationship by ID Delete a contextual relationship link between two entities in OneTrust by relationship type name and relationship id. Returns an empty 204 response on success. Required: relationship_type_name, id.
• List List all OneTrust relationship type relationships Get a relationship between entities in OneTrust by relationship type ID and relationship ID. Returns the relationship information including id, source entity, target entity, relationship type details, createdDate, and lastUpdatedDate. Required: relationship_type_id, relationship_id.
• Delete Delete a OneTrust relationship type relationship by ID Delete a contextual link between two entities in OneTrust by relationship type ID. Returns an empty 204 response on success. Required: relationship_type_id, id.
• Create Create a OneTrust custom entity project Create a new OneTrust Project object record. Returns: id, name, description, entityTypeId, attributes, createdBy, createdDate, lastModifiedBy, lastModifiedDate, entityDetail. Required: name.
• Search OneTrust custom entity projects search Search OneTrust Project objects by key terms and filters. Returns a list of project records with id, name, description, entityTypeId, attributes, createdBy, createdDate, lastModifiedBy, lastModifiedDate, entityDetail.
• Get Get single OneTrust custom entity project by ID Get a single OneTrust Project object by id. Returns: id, name, description, entityTypeId, attributes, createdBy, createdDate, lastModifiedBy, lastModifiedDate, entityDetail, links. Required: id.
• Update Update a OneTrust custom entity project by ID Partially update an existing OneTrust Project object by id. Returns: id, type, description, example, name. Required: id.
• Delete Delete a OneTrust custom entity project by ID Delete an existing OneTrust Project object by id. Returns an empty 204 response on success. Required: id.
• Search OneTrust projects basic details search Search OneTrust Project objects by query string and filters to retrieve basic details. Returns a paginated list of matching projects with id and name. Required: query. Only supports Project objects created via Object Manager.
• Create Create a OneTrust custom entity model Create a new AI/ML Model object in OneTrust. Returns the created model entity with id, name, number, organization, schemaId, entityType, workflow, stage, createdDate, lastModifiedDate, and attribute arrays for biases, description, referenceLink, limitations, modelVersion, fairness metrics, and more. Required: name.
• Search OneTrust custom entity models search Search Model objects in OneTrust by key terms and filters. Returns model records with id, name, number, organization, schemaId, entityType, workflow, stage, createdDate, lastModifiedDate, and attribute arrays including biases, description, limitations, and more.
• Get Get single OneTrust custom entity model by ID Get a single Model object in OneTrust by id. Returns: id, description, example, name. Required: id.
• Update Update a OneTrust custom entity model by ID Update an existing Model object in OneTrust by id. Returns: id, description, example, name. Required: id.
• Delete Delete a OneTrust custom entity model by ID Delete a Model object in OneTrust by id. Returns an empty 204 response on success. Required: id.
• Search OneTrust models basic details search Search OneTrust model objects by query string to retrieve basic identifier details. Returns: id, name. Required: query. Only supports Model objects created via Object Manager.
• Create Create a OneTrust entity Create a new object record in OneTrust Object Manager for Projects, Models, or Datasets. Returns the created object including id, number, name, organization, schemaId, entityType, workflow, stage, createdDate, and lastModifiedDate. Required: name.
• Search OneTrust entities search Search OneTrust Object Manager objects by filter criteria and full-text query. Returns matching objects with id, number, name, organization, entityType, workflow, stage, createdDate, and content-type-specific attributes. Supports Projects, Models, and Datasets objects.
• Get Get single OneTrust entity by ID Get a single OneTrust Object Manager object by id. Returns the full object including id, number, name, organization, schemaId, entityType, workflow, stage, createdDate, lastModifiedDate, and content-type-specific attributes. Required: id.
• Update Update a OneTrust entity by ID Partially update an existing OneTrust Object Manager object by id. Returns the updated object including id, number, name, organization, schemaId, entityType, workflow, stage, createdDate, and lastModifiedDate. Required: id.
• Delete Delete a OneTrust entity by ID Delete a OneTrust Object Manager object by id. Returns an empty 204 response on success. Required: id.
• Search OneTrust entity basic details search Search OneTrust object records by key terms and attribute filters. Returns: id, type, description, example. Required: entityTypeId. Only supports objects created via Object Manager (Projects, Models, Datasets).
• Create Create a OneTrust entity link type Create a new relationship type between two object types in OneTrust. Returns: id, name, nameKey, schemaName, seeded, moduleName, description, descriptionKey, entityType1ToEntityType2EntityLinkName, entityType1ToEntityType2EntityLinkNameKey, entityType2ToEntityType1EntityLinkName, entityType2ToEntityType1EntityLinkNameKey, enableAudit, allowNewCustomLinkAssociation, auditFields, linkAssociations.…
• Search OneTrust entity link types search Search for relationship link types in OneTrust by full-text query and field filters. Returns a paginated list with each record containing id, name, nameKey, schemaName, seeded, moduleName, description, enableAudit, allowNewCustomLinkAssociation, auditFields, and linkAssociations. Only supports objects created via Object Manager (Projects, Models, Datasets).
• Get Get single OneTrust entity link type by ID Get a single relationship type in OneTrust by its unique identifier (UUID). Returns: id, name, nameKey, schemaName, seeded, moduleName, description, descriptionKey, entityType1ToEntityType2EntityLinkName, entityType1ToEntityType2EntityLinkNameKey, entityType2ToEntityType1EntityLinkName, entityType2ToEntityType1EntityLinkNameKey, enableAudit, allowNewCustomLinkAssociation, auditFields. Required:…
• List List all OneTrust entity types names Get a OneTrust custom entity type by its name. Returns the full object type including id, name, nameKey, seeded, moduleName, schemaName, description, enabled, moduleScopes, settings, and auditFields. Required: entity_type_name. Only supports objects created via Object Manager (Projects, Models, Datasets).
• Update OneTrust entity types names update enable Enable a OneTrust custom entity type by its name. Returns an empty 204 response on success. Required: entity_type_name. Only supports objects created via Object Manager (Projects, Models, Datasets).
• Update OneTrust entity types names bulk update Partially update a OneTrust custom entity type by its name. Returns the updated object type including id, name, nameKey, seeded, moduleName, schemaName, description, enabled, moduleScopes, settings, and auditFields. Required: entity_type_name. Only supports objects created via Object Manager (Projects, Models, Datasets).
• Search OneTrust entity types search Search OneTrust object types (entity types) by full-text terms and attribute filters. Returns each matching object type with id, name, enabled, seeded, moduleScopes, settings, and auditFields. Only supports objects created via Object Manager (Projects, Models, Datasets).
• Get Get single OneTrust entity type by ID Get a single OneTrust object type (entity type) by its unique identifier. Returns: id, name, nameKey, seeded, moduleName, schemaName, description, descriptionKey, workflowType, enabled, moduleScopes, settings, auditFields. Required: id.
• Update Update a OneTrust entity type by ID Partially update an existing OneTrust object type (entity type) by its unique identifier. Returns the updated object type including id, name, enabled, moduleScopes, settings, and auditFields. Required: id.
• Update OneTrust entity types bulk update Enable a OneTrust object type (entity type) by its unique identifier. Returns an empty 204 response on success. Required: entity_type_id.
• Create Create a OneTrust link Create a new relationship record between OneTrust Object Manager objects such as Projects, Models, and Datasets. Returns the created relationship including id, linkType, entity1, entity1Type, entity2, entity2Type, createdDate, and lastModifiedDate. Required: linkTypeId, entity1, entity2.
• Get Get single OneTrust link by ID Get a specific relationship record between OneTrust Object Manager objects by id. Returns: id, linkType, entityType1ToEntityType2, entityType2ToEntityType1, entity1, entity1Type, entity2, entity2Type, createdDate, lastModifiedDate. Required: id, linkTypeId.
• Delete Delete a OneTrust link by ID Delete an existing relationship record between OneTrust Object Manager objects by id. Returns an empty 204 response on success. Required: id, linkTypeId.
• Create Create a OneTrust schema attribute option Add options to a custom entity attribute in OneTrust Object Manager. Returns the updated attribute object including id, name, responseType, options, optionType, createdTime, and lastModifiedTime. Required: attributeId and a body array of option objects each containing option and optionKey. Only supports objects created via Object Manager (Projects, Models, Datasets).
• Create Create a OneTrust schema attribute Create an attribute for a specific schema in OneTrust. Returns the created attribute including id, name, nameKey, responseType, encrypted, enabled, required, createdBy, createdTime, and lastModifiedTime. Required: schema_name, schemaName. Only supports Object Manager objects (Projects, Models, Datasets).
• Update OneTrust schema attributes update enable Enable a schema attribute in OneTrust Object Manager. Returns: id, name, nameKey, description, descriptionKey, encrypted, enabled, required, responseType, scoreLevelName, options, optionType, referenceCategoryIds, responseSubType, maxMultiSelectAllowedOptionValues, metadata, formula, createdBy, createdTime, lastModifiedBy, lastModifiedTime. Required: attribute_id, schemaId.
• List List all OneTrust schema attributes Get details of a specific inventory schema attribute by field name in OneTrust. Returns: id, name, nameKey, description, descriptionKey, fieldName, mappedFieldName, enabled, required, readOnly, encrypted, allowOther, baseAttribute, responseType, formula, optionType, optionAllowed, schemaId, schemaName, responseMaxLength, source, responseSubType, multiSelectMaxOptionValues, hidden. Required:…
• Update OneTrust schema attributes bulk update Disable a schema attribute in OneTrust Object Manager. Returns: id, name, nameKey, description, descriptionKey, encrypted, enabled, required, responseType, scoreLevelName, options, optionType, referenceCategoryIds, responseSubType, maxMultiSelectAllowedOptionValues, metadata, formula, createdBy, createdTime, lastModifiedBy, lastModifiedTime. Required: attribute_id, schemaId.
• Create Create a OneTrust task Create a new task for an object in OneTrust. Returns the created task including id, taskName, status, priority, deadline, assigneeId, and task assignment details. Only supports objects created via Object Manager (Projects, Models, Datasets).
• Get Get single OneTrust task by ID Get a specific task on an object in OneTrust by id. Returns task details including id, taskName, status, priority, deadline, assigneeId, and task assignment information. Required: id.
• Update Update a OneTrust task by ID Update an existing task for an object in OneTrust by id. Returns the updated task including id, taskName, status, priority, deadline, assigneeId, and task assignment details. Required: id.
• Create Create a OneTrust task management task Create a new issue task for an object in OneTrust. Returns the created task including id, taskName, status, priority, deadline, assigneeId, and taskAssignmentInformations. Required: parentEntityId, taskName.
• Get Get single OneTrust task management task by ID Get a specific issue task by id in OneTrust. Returns the task including id, taskName, status, priority, deadline, assigneeId, and taskAssignmentInformations. Required: id, taskTypeNameKey.
• Update Update a OneTrust task management task by ID Update an existing issue task by id in OneTrust. Returns the updated task including id, taskName, status, priority, deadline, assigneeId, and taskAssignmentInformations. Required: id, taskTypeNameKey.
• List List all OneTrust SCIM resource types List supported SCIM resource types in OneTrust (User and Group) for Legacy SCIM user provisioning from an Identity Provider. Returns each resource type with its id, name, description, endpoint, schema (core schema URI), schemaExtensions, and meta.
• Get Get single OneTrust SCIM resource type by ID Get a single SCIM resource type by resource name in OneTrust. Returns the resource type including its id, name, description, endpoint, schema (core schema URI), schemaExtensions, and meta. Required: resource_name.
• List List all OneTrust SCIM schemas List SCIM 2.0 schemas supported by OneTrust for legacy SCIM user provisioning. Returns each schema with id, name, description, fieldName, responseType, enabled, and additional attribute metadata.
• Get Get single OneTrust SCIM schema by ID Get a specific SCIM 2.0 schema by schema name in OneTrust. Returns the schema definition including id, name, description, fieldName, responseType, enabled, and additional attribute metadata. Required: schema_name.
• List List all OneTrust SCIM service provider configs Retrieve the OneTrust SCIM service provider configuration resource, which describes supported SCIM specification features and implementation details for automated user provisioning from a third-party identity provider. Returns: attributes. This API supports OneTrust's Legacy SCIM Integration that leverages SCIM groups (unique role-organization combinations).
• Create Create a OneTrust assessment review Complete the review of an assessment in OneTrust, moving it to the Completed stage using an active result option. Returns an empty 204 response on success. Required: assessment_id. The assessment must first be submitted for review before calling this API, and only active assessment result options can be used.
• List List all OneTrust assessment assessment tags List all available assessment tags in OneTrust that can be used to categorize or label assessments. Returns: id. The returned tag IDs can be used with the Update Assessment Tags API to tag a specific assessment.
• List List all OneTrust assessments List OneTrust assessments with basic details. All assessments are returned regardless of stage by default; filter by status, template type, or archival state. Returns: id, number, status, name, result, orgGroupName, deadline, openRiskCount, openInfoRequestCount, createdDate. Max 2000 per page.
• Create Create a OneTrust assessment Launch a new OneTrust assessment with the provided details and assigned respondents. The templateRootVersionId can be used instead of templateId to create from the latest published template version. Returns: the UUID of the newly created assessment. Required: name, respondents.
• Create OneTrust assessments bulk create Create OneTrust assessments in bulk — one assessment is created for each inventory ID passed in the request body array. The same or different templates can be used per inventory ID. Returns an empty 202 response on success. Required: name, respondents (per item).
• Approve OneTrust assessments approve Approve a OneTrust assessment, moving it to the Completed stage. The assessment must be submitted before calling this API. Returns an empty 204 response on success. Required: assessment_id.
• Update OneTrust assessments bulk update Update the tags associated with a specific OneTrust assessment. The submitted tags overwrite all existing tags on the assessment, and new tags can also be created through this API. Returns an empty 204 response on success. Required: id.
• List List all OneTrust types assessmentdeletes Export an audit log of all deleted assessments from OneTrust. Returns each log entry including assessmentId, assessmentName, deletedBy, and deletedOn. The exported log only includes assessments deleted after OneTrust 4.1.
• Update OneTrust assessments archives bulk update Archive one or more OneTrust assessments by ID. Multiple assessment UUIDs can be passed in the request body for bulk archiving; archived assessments become read-only. Returns an empty 204 response on success. Required: body (array of assessment UUIDs). Dynamic Incident Notification, Program Benchmarking, and Maturity & Planning assessments cannot be archived.
• Create Create a OneTrust assessments assessment link Link an assessment to multiple assessments in OneTrust. Supports linking active and archived assessments; only assessments with template types PIA, Vendor, ITRM, Control, Exchange, Incident, and ESG can be linked. Returns an empty 201 Created response on success. Required: a request body specifying the assessments to link.
• List List all OneTrust assessments assessment results List assessment result options in OneTrust that can be used to complete an assessment. Returns: id. The id of each result option can be passed to the Complete Assessment API to move an assessment to the Completed stage.
• List List all OneTrust reference object assessments List all assessments linked to a OneTrust reference object record, including copied, reassessed, and rule-triggered related assessments. Returns: id, name. Required: reference_object_id, referenceType. If the ID does not match the specified reference-object type, 0 results are returned.
• Update OneTrust assessments un archives bulk update Unarchive one or more OneTrust assessments by providing assessment UUIDs in the request body array. Unarchived assessments move back to the Active list and become editable. Returns an empty 204 response on success. Dynamic Incident Notification Assessments, Program Benchmarking Assessments, and Maturity & Planning Assessments cannot be unarchived.
• List List all OneTrust assessment exports Export full details of a OneTrust assessment by assessment_id. Returns the assessment export including basic assessment information, respondents, approvers, questions and responses, and assessment risks. Required: assessment_id.
• Update OneTrust metadata bulk update Update basic assessment details (name, description, deadline, and reminder) for a OneTrust assessment. Returns an empty 204 response on success. Required: assessment_id. Updates are ignored if the assessment is in Completed stage; supports PIA, Vendor, ITRM, Control, Exchange, and Incident assessment types.
• Update OneTrust assessment primary records bulk update Set or update the primary record on a OneTrust assessment, either editing the existing primary record or creating a new one from the attributes in the request body. Returns an empty 204 response on success. Required: assessment_id. The primary record list cannot exceed 1 for Inventory primary record types but may be greater than 1 for Assess Control primary record types.
• Update OneTrust assessment reassigns bulk update Reassign the organization, approvers, and/or respondents of a OneTrust assessment. Returns an empty 204 response on success. Required: assessment_id. Reassignments are ignored for assessments in the Completed stage; supports PIA, Vendor, ITRM, Control, Exchange, and Incident types.
• List List all OneTrust assessment records Get an assessment record from OneTrust containing basic assessment information, sections with questions and responses, and current status. Returns: assessmentId, status, sections. By default returns a lightweight record; set showAllDetails to true for the full export with risks, approvers, respondents, and attachments. Required: assessment_id.
• Create Create a OneTrust assessment response Submit responses for an assessment in OneTrust by providing a list of response entries in the request body. Returns the updated assessment information object including id and assessment attributes (202 Accepted). Required: assessment_id. Responses cannot be added to assessments that have already been completed.
• Create Create a OneTrust assessment risk Create a risk on an assessment in OneTrust. The risk is flagged on the assessment and assigned to the respective risk owners with the details provided in the request body. Returns the risk owner, risk approver, and target risk level. Required: assessment_id. Can be used for assessments in Under Review and Completed stage; if risk heatmaps are not used, available risk level options are Low,…
• List List all OneTrust assessment score profiles List OneTrust assessment score profiles for a submitted assessment, including overall profile scores, question-level score breakdowns, section and question names, selected options with individual scores, and question weights and scoring types. Returns: id. Required: assessment_id. Returns an empty list when no score profiles are configured or no scores have been calculated.
• Update OneTrust assessment soft deletes bulk update Soft delete a OneTrust assessment by moving it to the recycle bin, where it remains until restored or permanently deleted. Returns an empty 204 response on success. Required: assessment_id. Only assessments in the PIA & DPIA Automation and IT & Security Risk Management modules can be soft deleted; Dynamic Incident Notification, Program Benchmarking, and Maturity & Planning assessments cannot be…
• Create Create a OneTrust assessment submit Submit a OneTrust assessment for review, moving it to the Under Review stage. Returns an empty 204 response on success. Required: assessment_id. Responses for all required questions must be submitted first before calling this endpoint.
• Create Create a OneTrust assessment task Create a new task on a OneTrust assessment. Only one task can be created per API call; tasks cannot be created for Global Readiness, Readiness, Program Benchmarking, or Dynamic Incident Notification assessments. Returns the UUID of the newly created task. Required: assessment_id.
• List List all OneTrust assessment workflows Get workflow and approval stage details for a OneTrust assessment, including the current workflow stage the assessment is in. Returns: id, name, type. Required: assessment_id.
• Create Create a OneTrust assessment reassese Reassess an existing OneTrust assessment using the latest published template version. Returns the UUID of the newly created reassessment. Required: assessment_id. Use copyAssessmentMetadata to copy or override source assessment details, and archiveSourceAssessment to control archiving of the original.
• Create Create a OneTrust assessment reopen Reopen a specific OneTrust assessment from the Completed stage to the Under Review stage to request more information from respondents, who receive comments via email notification. Returns an empty 200 response on success. Required: assessment_id.
• Create Create a OneTrust assessment send back Send back an OneTrust assessment to request more information from respondents, moving it from the Under Review stage to the In Progress stage with comments emailed to the respondent. Returns an empty 200 response on success. Required: assessment_id.
• Get Get single OneTrust comments assessment by ID Get all comments for a OneTrust assessment by id, paginated and sorted by section and question sequence. Returns comment records including id and attributes. Required: id.
• Create Create a OneTrust assessments comment Create a new comment on an assessment question in OneTrust. Returns the UUID identifier of the newly created comment. Requires a comment information request body.
• Get Get single OneTrust assessments list by ID List OneTrust assessments with optional filters by template types, statuses, archival state, and request-body criteria like approver Ids, respondent Ids, and template Ids. Returns: id, name. Max 2000 records per page.
• List List all OneTrust template published template metadatas List all published templates in OneTrust. Returns an array of basic template details including templateName, templateRootVersionId, and templateType. Optionally filter by one or more template types; if no type is specified, all template types are returned.
• Create Create a OneTrust templates import Import a OneTrust template by uploading template metadata JSON (obtained from the Export Template API) to migrate it between environments or tenants. Returns: id, name, status. Required: matchAttributesByName and a request body containing the template metadata. The imported template appears in Draft status; duplicate template names will cause a 400 error.
• Delete OneTrust root version templates bulk delete Delete a OneTrust template by its root version identifier. The template must not be associated with any Assessment or action rules of other templates; only template types PIA, VENDOR, ITRM, CONTROL, INCIDENT, EXCHANGE, ESG, DISCLOSURE, ERM, TPDD, and DISCLOSURE_YOY can be deleted. The root version id can be obtained from the Get List of Templates API. Required: root_version_id. Returns an empty…
• List List all OneTrust template exports Export a OneTrust template's metadata as JSON for migration between environments or tenants. Returns the template object including its id, name, and status. Required: template_id. When templateVersion is specified, pass the templateRootVersionId as template_id.
• List List all OneTrust inventory data classifications List all existing Data Classifications in OneTrust's Data Mapping Automation module. Returns: id, name, description, createdDate, lastUpdatedDate.
• Create Create a OneTrust inventory data classification Create a new Data Classification in OneTrust's Data Mapping Automation module. Returns the created data classification including its id, name, createdDate, and description. Required: name.
• Get Get single OneTrust inventory data classification by ID Get a single Data Classification by id in OneTrust. Returns: id, name, description, createdDate, lastUpdatedDate. Required: id.
• Delete Delete a OneTrust inventory data classification by ID Delete a Data Classification by id in OneTrust. Returns an empty 204 response on success. Required: id.
• List List all OneTrust inventory data elements List all existing Data Elements in OneTrust's Data Mapping Automation module. Returns: id, name, description.
• Create Create a OneTrust inventory data element Create a new data element in OneTrust's Data Mapping Automation module. Returns the created data element's id and detailed attributes. A JSON request body defining the data element is required.
• Get Get single OneTrust inventory data element by ID Get a single OneTrust inventory data element by its UUID identifier. Returns the data element object including its id and content-type-specific attribute fields. Required: id.
• Delete Delete a OneTrust inventory data element by ID Delete a OneTrust inventory data element by its UUID identifier. Returns an empty 204 response on success. Required: id.
• List List all OneTrust inventory schemas List all inventory schemas available in OneTrust. Returns: id, name, description, nameKey, uri.
• List List all OneTrust attribute values Get a specific OneTrust attribute value (option) by attribute and value IDs. Returns: id, description. Required: attribute_id, value_id.
• Create OneTrust attribute values bulk create Create multiple attribute values (options) for an attribute in OneTrust. Returns: id, value, description, enabled. Required: attribute_id. Only supports single/multi select response type attributes that are not user/location/date attribute type.
• Update Update a OneTrust attribute value by ID Update a OneTrust inventory attribute option — edit the option name, description, or activate/deactivate it. Returns the updated attribute value including id, value, description, and enabled. Required: attribute_id, id.
• List List all OneTrust inventory data categories List all Data Categories in OneTrust's Data Mapping Automation module. Returns: id, name. Max 50 records per page.
• Create Create a OneTrust inventory data category Create a new Data Category in OneTrust's Data Mapping Automation module. Returns: id, name. Required: name.
• Get Get single OneTrust inventory data category by ID Get a single Data Category by id in OneTrust. Returns: id, name. Required: id.
• Delete Delete a OneTrust inventory data category by ID Delete a Data Category by id in OneTrust. The data category must have no data-elements assigned to it. Returns an empty 204 response on success. Required: id.
• List List all OneTrust inventory data subjects List all Data Subjects in OneTrust's Data Mapping Automation Module. Returns: Id. Max 50 records per page.
• Create Create a OneTrust inventory data subject Create a new Data Subject in OneTrust's Data Mapping Automation Module. Returns: Id. Required: Identifier.
• Get Get single OneTrust inventory data subject by ID Get a single Data Subject in OneTrust by id. Returns: Id. Required: id.
• Delete Delete a OneTrust inventory data subject by ID Delete a Data Subject in OneTrust by id. Returns an empty 204 response on success. Required: id.
• Update Update a OneTrust inventorie association by ID Update a bidirectional inventory link between two inventories in OneTrust. Returns an empty 200 response on success. Required: id, association_id.
• List List all OneTrust inventorie personal datas List existing links between an OneTrust inventory and personal data items. Returns each link including its id, dataElement, dataSubjectType, dataCategories, dataClassifications, source, dateLinked, and hidden flag. Required: inventory_id.
• Create Create a OneTrust inventorie personal data Create one or more links between an OneTrust inventory and personal data items. Returns each created link including its id, dataElement, dataSubjectType, dataCategories, dataClassifications, source, dateLinked, and hidden flag. Required: inventory_id and a body array of dataElement and dataSubjectType link requests.
• Delete OneTrust inventorie personal datas bulk delete Permanently delete links between an OneTrust inventory and personal data items. Returns an empty 204 response on success. Required: id and a body array of dataElement and dataSubjectType link requests to delete.
• Create Create a OneTrust inventorie relation Create bidirectional links between a OneTrust inventory and one or more other inventories by sending an array of link objects. Returns: inventoryId, inventoryAssociationId. Required: inventory_id, body (array of objects each with id and relation).
• List List all OneTrust inventorie relations List existing links between a OneTrust inventory and other inventories of a specified type. Returns: inventoryId, inventoryAssociationId, inventoryType, anchorInventoryId, inventoryAssociationTypeKey, inventoryAssociationType, name, organization, organizationId, type, typeKey, editable. Required: inventory_id, inventory_type.
• Update OneTrust inventorie relations bulk update Update bidirectional links between a OneTrust inventory and one or more other inventories by sending an array of link objects. Returns: inventoryId, inventoryAssociationId. Required: id, body (array of objects each with id and relation).
• Delete OneTrust inventorie relations bulk delete Delete one or more existing links between a OneTrust inventory and other inventories by sending an array of association IDs. Returns a 200 OK response with no documented response body on success. Required: id, body (array of objects each with inventoryAssociationId).
• Action OneTrust inventory inventories attach attachment Add existing attachments to a OneTrust inventory record so they appear under the Documents tab of the Inventory Details page. Returns an empty 201 response on success. Required: inventory_id.
• List List all OneTrust inventory inventories List OneTrust inventory records for a given schema type (vendors, assets, processing-activities, or entities). Returns: id, type, example. Required: schema_name.
• Create Create a OneTrust inventory inventory Create a new OneTrust inventory record of a given schema type (vendors, assets, processing-activities, or entities). Returns: id. Required: schema_name.
• Get Get single OneTrust inventory inventory by ID Get a single OneTrust inventory record by id and schema type. Returns: id, type, example. Required: schema_name, id.
• Update Update a OneTrust inventory inventory by ID Update an existing OneTrust inventory record by id and schema type. Only include the fields that need to be updated. Returns: id, type, status, example. Required: schema_name, id.
• Delete Delete a OneTrust inventory inventory by ID Delete an inventory record in OneTrust by schema name and record id. Supports SOFT (marks as deleted but retains) and HARD (permanent) deletion via the deleteType query parameter. Returns an empty 200 response on success. Required: schema_name, id.
• List List all OneTrust personal data attributes Get the attribute values tracked at an Inventory Personal Data link in OneTrust. Returns the personal data association attributes object, whose keys are configuration-dependent — the specific attribute names and values depend on which attributes are configured to be tracked for this inventory personal data association. Required: inventory_id, personal_data_association_id.
• Set OneTrust inventorie set as parents bulk update Set an existing inventory as a parent inventory in OneTrust. Returns an empty 201 response on success. Required: inventory_id, inventoryType.
• Update OneTrust inventorie unset as parents bulk update Unset an existing OneTrust inventory from being a parent inventory. Returns an empty 201 response on success. Required: inventory_id, inventoryType.
• Create Create a OneTrust inventorie link asset Link existing asset inventories as children to a parent asset inventory in OneTrust. Accepts an array of child inventory UUIDs to attach. Returns an empty 201 response on success. Required: parent_inventory_id.
• Create Create a OneTrust inventorie link legal entity Link one or more existing legal entity inventories as children to a parent legal entity inventory in OneTrust. Returns a 201 Created response with no response body on success. Required: parent_inventory_id and a body array of child inventory UUIDs.
• Create Create a OneTrust inventorie link processing activity Link one or more existing processing activity inventories as child inventories to a parent processing activity inventory in OneTrust. Pass an array of child inventory UUIDs in the request body. Returns an empty 201 response on success. Required: parent_inventory_id and a body array of child inventory UUIDs.
• Create Create a OneTrust inventorie link vendor Link existing vendor inventories as child inventories to a parent vendor inventory in OneTrust. Accepts an array of child vendor inventory UUIDs in the request body. Returns an empty 201 response on success. Required: parent_inventory_id.
• Get Get single OneTrust inventorie business key by ID Retrieve inventory IDs for given business keys in OneTrust by schema type. Returns an array of key-id mappings: key (the business key sent in the request) and id (the inventory record UUID). Required: schema_name.
• Update OneTrust inventorie business keys bulk update Upsert an inventory record by external business key in OneTrust — creates a new record if none exists or updates the existing one. Returns the data object containing id, name, and externalId of the upserted record. Required: schema_name, name, organization.
• Get Get single OneTrust inventorie criteria by ID Retrieve a paginated list of OneTrust inventories by schema type and filter criteria. Returns inventory records with id, name, organization, status, number, isParent, isEditable, isDeletable, and canViewDetails. Required: schema_name and a filter criteria request body. Max 50 records per page.
• Get Get single OneTrust inventorie identifier by ID Retrieve a paginated list of inventory identifiers for a given inventory type in OneTrust with advanced filtering capabilities. Returns: Id. Required: schema_name.
• List List all OneTrust inventorie references Get a OneTrust inventory item by external ID. Returns the data object containing the inventory record including id, name, organization, status, isEditable, isDeletable, canViewDetails, createdDate, updatedDate, and owner. Required: schema_name, external_id.
• Create Create a OneTrust copy Create a copy of an existing OneTrust inventory record. Returns the copied inventory including id, name, status, and description. Required: schema_name, inventory_id.
• List List all OneTrust attributes List OneTrust attribute schemas for a specified schema type in issue management. Returns: id, name, description, required. Required: schemaName.
• Update OneTrust attributes bulk update Update attribute values for attributes tracked at an Inventory Personal Data link in OneTrust. Returns an empty 200 response on success. Required: schema_name, id, related_schema_name, link_id.
• Update OneTrust status bulk update Update the status of an existing OneTrust inventory record by schema name and record id. Accepts a body with the new status key and optional display name. Returns a 200 OK response with no response body on success. Required: schema_name, id.
• Create Create a OneTrust control implementation Create one or more control implementations on a OneTrust inventory item by specifying the inventory type, inventory id, and the id(s) of the master controls to implement. Returns a 201 Created response with no body on success. Required: type, inventory_id.
• Update Update a OneTrust inventory inventories personal data by ID Update the advanced attributes of a Personal Data Association linked to an inventory object in OneTrust. Returns an empty 200 response on success. Required: id, inventoryType.
• Get Get single OneTrust inventory inventory hierarchy by ID List child inventories linked to a root inventory in OneTrust, filtered by inventory type. Returns a paginated list of child inventory records including id, name, and createdDate. Required: id, inventoryType. Max 50 records per page.
• Delete Delete a OneTrust inventory inventory hierarchy by ID Unlink a child inventory from a root inventory in OneTrust. Returns an empty 204 response on success. Required: id, inventoryType, childInventoryId.
• Update OneTrust attributes activates bulk update Activate attribute values for an OneTrust inventory schema by specifying field names. Returns an empty 204 response on success. Required: schema_name. The schema_name must be one of: processing-activities, vendors, assets, entities.
• Update OneTrust attributes deactivates bulk update Deactivate inventory attribute values by field names in OneTrust. Accepts a list of fieldNames to deactivate for the specified schema. Returns an empty 204 response on success. Required: schema_name, fieldNames.
• Search OneTrust inventory vendors search Search OneTrust inventory vendors by name or website. Returns vendor records including id, name, website, orgGroupId, and orgGroupName. At least one of name or website must be provided.
• List List all OneTrust group requestqueues Get a Targeted Data Discovery group's results for a specified DSAR request in OneTrust. Returns: name. Required: group_id, request_queue_ref_id.
• Get Get single OneTrust datadiscovery requestqueue by ID Get a list of Targeted Data Discovery groups for a specified request in OneTrust. Returns: id, name, order for each group. Required: id.
• Create Create a OneTrust datadiscovery requestqueue Add Targeted Data Discovery results to a request in OneTrust. A JSON request body containing the data discovery group data is required. Returns an empty 200 response on success. Required: requestqueue_id.
• Create Create a OneTrust datasubject requestqueue Create a data subject request for a given hosted web form in OneTrust. Deprecated as of March 3, 2022. Returns: requestQueueRefId, createdDate, attributes, id. Required: attributes.
• List List all OneTrust datasubject requestqueues List all data subject requests in OneTrust for a specified language, with optional filters by creation date, modification date, and status. Returns: requestQueueRefId, createdDate, attributes. Required: language.
• Get Get single OneTrust datasubject requestqueue by ID Get a single OneTrust data subject request queue record by request_queue_ref_id and id. Returns: id, attributes. Required: request_queue_ref_id, id.
• Update OneTrust datasubject requestqueues bulk update Add a comment to a OneTrust data subject request. Returns an empty 200 response on success. Required: request_queue_ref_id.
• Update OneTrust requestqueues bulkdeletes bulk update Delete OneTrust DSAR requests in bulk. Associated subtasks, attachments, and Results Summaries are also permanently deleted. Returns the bulk delete response object. Required: language.
• Get Get single OneTrust requestqueues delete certificate by ID Get a deletion certificate for a deleted OneTrust data subject request by id. Returns the deletion certification including retentionPolicy, deletionDate, and deletionMode. Required: id. Certificate data is available only for requests deleted within the past 360 days.
• List List all OneTrust requesthistories List the audit history of a OneTrust DSAR request by request queue ID. Returns audit entries including field updates and the date and time when changes were made. Required: request_queue_id. Max 500 records per page.
• Create Create a OneTrust results summary share Share a data discovery results summary with the data subject via email in OneTrust. Supports CSV or PDF format; PDF shares require a report template ID. Processing is asynchronous — optionally track progress via subtaskId or mark the entire request complete with markRequestAsComplete. Required: share_id. Returns an empty 200 response on success.
• Search OneTrust requestqueues searches search Search OneTrust DSAR requests by key terms such as the data subject's first name, last name, email address, or request ID. Returns a paginated result page containing content, totalElements, totalPages, number, numberOfElements, pageable, sort, empty, first, and last. Required: language.
• Get Get single OneTrust requestqueues status by ID Get request creation logs for a OneTrust DSAR request by trace ID. Returns: createdDate, creationStatus, requestId. Required: id.
• Update OneTrust requestqueue customfields bulk update Update the custom fields of a OneTrust DSAR request by passing a map of field key-value pairs. Returns the updated request queue object including requestQueueRefId, status, and request type. Required: request_queue_ref_id, language.
• List List all OneTrust requestqueue languages Get a single OneTrust DSAR request by its reference ID and language code. Returns the request including approver details, date created, and the data subject's first and last name. Required: request_queue_ref_id, language.
• Update OneTrust requestqueue linkrequests bulk update Link or unlink an existing OneTrust privacy request to one or multiple related requests. Returns an empty 200 response on success. Required: request_queue_ref_id.
• Update OneTrust requestqueue movestages bulk update Update the workflow stage for a specific OneTrust data subject request. Returns: nextStage, resolutionTitle, comments, isInternalComment. Required: request_queue_ref_id, language, nextStage. Valid nextStage values: NEW, VERIFYING_IDENTITY, IN_PROGRESS, REJECTED, COMPLETE; resolutionTitle, comments, and isInternalComment apply only when nextStage is REJECTED.
• Update OneTrust requestqueue pausedeadlines bulk update Pause the deadline of a data subject request in OneTrust. The deadline is removed from the request until it is resumed; once resumed, it is adjusted based on the time it was paused. The request auto-resumes when the data subject responds, and manual resumption is also supported. Returns a 200 OK response with no response body on success. Required: request_queue_ref_id. A JSON request body is also…
• List List all OneTrust requestqueue requesthistories List OneTrust DSAR request audit history entries for a specific request. Returns audit history records with id and attributes including field updates and timestamps. Required: request_queue_ref_id.
• List List all OneTrust requestqueue subtasks List all subtasks for a specific OneTrust data subject request. Returns: subTaskId, taskName, subtaskDateCreated, subtaskDateUpdated, requestDeadline, requestTypeName, subjectTypeName, requestDateCreated. Required: request_queue_ref_id.
• Create Create a OneTrust requestqueue subtask Add a subtask to a data subject request in OneTrust. Returns the created subtask object including its id, deadline, createdDate, and requestApprover. Required: request_queue_ref_id.
• Create Create a OneTrust subtasks template Add a subtask to a OneTrust data subject request using a subtask template. Returns the created subtask object including the request approver, date created, and deadline. Required: request_queue_ref_id and a request body specifying the subtask template name.
• List List all OneTrust requestqueue verificationmethods List all verification methods for a OneTrust privacy request. Returns each method's id, description, createdDate, and lastModifiedDate. Required: request_queue_ref_id, includeComments.
• Create Create a OneTrust requestqueue verificationmethod Create a new verification method for a OneTrust privacy request. Returns the created method including Id, Identifier, Language, CreatedDate, LastUpdatedDate, DataElements, and TestDataSubject. Required: request_queue_ref_id.
• Update OneTrust requestqueue verificationmethods bulk update Update an existing verification method for a OneTrust privacy request. Returns the updated method including Id, Identifier, Language, CreatedDate, LastUpdatedDate, DataElements, and TestDataSubject. Required: request_queue_ref_id.
• List List all OneTrust datasubject resolutions List all OneTrust data subject request resolutions. Returns: id, type. Optional filters include language for retrieving translations in a specific locale and includeSubTaskResolutions for subtask-level codes. Max 500 records per page.
• Create Create a OneTrust datasubject resolution Create a new OneTrust data subject request resolution. Returns the created resolution object including id, type, translations, createdDate, and lastModifiedDate.
• Update Update a OneTrust datasubject resolution by ID Update an existing OneTrust data subject request resolution by id. Returns the updated resolution object including id, type, translations, createdDate, and lastModifiedDate. Required: id.
• Delete Delete a OneTrust datasubject resolution by ID Delete an existing OneTrust data subject request resolution by id. Returns an empty 200 response on success. Required: id.
• List List all OneTrust datasubject subtasks List onetrust data subject request subtasks. Returns each subtask's taskName, createdDate, lastModifiedDate, and status. Does not return subtasks in Complete status. Deprecated as of January 1, 2026 — use the Get List of Subtasks by Criteria API instead.
• Get Get single OneTrust datasubject subtask by ID Get a single onetrust data subject request subtask by id, including its assignee, deadline, and status details. Returns: taskName, createdDate, lastModifiedDate, status. Required: id.
• Update Update a OneTrust datasubject subtask by ID Update an existing onetrust data subject request subtask by id. Accepts a JSON request body with updated subtask fields. Returns an empty 200 response on success. Required: id.
• Update OneTrust datasubject subtasks bulk update Mark an onetrust data subject request subtask as Complete by subtask_id. Accepts a JSON request body to resolve the subtask. Returns an empty 200 response on success. Required: subtask_id.
• Add OneTrust add discoveries bulk update Add Targeted Data Discovery details to a OneTrust DSAR subtask by providing a JSON body of discovery attributes. Returns a 200 OK response with no response body on success. Required: subtask_id.
• Update OneTrust subtask reproceses bulk update Reprocess a system subtask in OneTrust. Returns a string response indicating the reprocess request was processed. Required: subtask_id. System subtasks in the Complete and Ready for Review statuses are not supported.
• Update OneTrust subtask status bulk update Update the status of an existing OneTrust DSR subtask. Returns a boolean indicating whether the update was applied successfully. Required: subtask_id, status. The resolutionId may only be supplied when status is COMPLETED or REJECTED.
• Update Update a OneTrust drop manager drop by ID Update the status and/or data subject access request ID of an existing DROP record in OneTrust. Returns an empty response on success. Required: id.
• Create Create a OneTrust request Create a data subject request for a DROP record in OneTrust. Returns the created request queue object. Required: drop_id.
• Create Create a OneTrust entitie stage Update the workflow stage for a specific OneTrust incident by its unique identifier. Returns: id, name, description. Required: entity_id, nextStageName.
• Create Create a OneTrust incident Create a new incident in OneTrust's Incident Register by providing the necessary details in the request body. Returns the UUID of the newly created incident. A request body with incident details is required.
• Get Get single OneTrust incident by ID Get a single incident in OneTrust by id, including its linked assessments, status, and associated attributes. Returns: id, name. Required: id.
• Update Update a OneTrust incident by ID Update the details of a specific incident in OneTrust by id. Returns the updated incident information including id, name, status, attributes, assessments, and createdDate. Required: id.
• List List all OneTrust search incidents Search incidents in OneTrust by key terms and filters. Returns an array of incident records including id, name, and createdDate. Max 2000 records per page.
• Create Create a OneTrust incident inventory link Link an OneTrust incident to one or more inventory records of a specified type. Returns a list of created inventory link associations. Required: incident_id, inventory_type. The inventory_type must be one of: assets, processing-activities, vendors, entities.
• Get Get single OneTrust document gateway by ID Download a document or attachment from OneTrust by id. Returns the document file content as a binary blob. Required: id.
• Delete Delete a OneTrust audit management audit scope by ID Delete an existing audit scope (control or control implementation) from an audit in OneTrust. Returns an empty 204 response on success. Required: id (scope UUID).
• Get Get single OneTrust audit workpapers page by ID List OneTrust audit workpapers by key terms and filters. Returns a paginated response with content (array of workpapers including id, name, number, associated audit, findings, and attributes), totalElements, and numberOfElements. Requires a request body.
• Update Update a OneTrust audit management audit workpaper by ID Update the attributes of a specific audit workpaper in OneTrust. Returns the updated workpaper including its id and name. Required: id. Workpaper assignees must be updated separately using the Update Audit Scope API.
• List List all OneTrust audit workpaper attribute details Retrieve the results and attribute details for a specific OneTrust audit workpaper. Returns the workpaper detail information object including its id and workpaper-specific attributes. Required: workpaper_id.
• List List all OneTrust audit workpaper control details Get the control details of a specific audit workpaper in OneTrust. Returns the control workpaper basic information object including its id and control-specific attributes. Required: workpaper_id.
• Create Create a OneTrust audit management audit Create a new audit in OneTrust. Returns the UUID of the newly created audit. Requires a request body with audit creation details.
• Get Get single OneTrust audit management audit by ID Get a single audit in OneTrust by its id. Returns: id, name. Required: id.
• Update Update a OneTrust audit management audit by ID Update the approvers, attributes, and auditors of a specific audit in OneTrust. Returns: id, name. Required: id.
• Delete Delete a OneTrust audit management audit by ID Delete an existing audit in OneTrust and its associated workpapers, tasks, and attachments. Audit deletion is permanent. Returns an empty 204 response on success. Required: id.
• Get Get single OneTrust audits page by ID Search and list OneTrust audits by key terms and filters. Returns each audit with its id, number, name, orgGroupId, startDate, endDate, approvers, attributes, and auditors. A SearchCriteriaRequest body is required. Defaults to 20 results per page sorted by number descending.
• Update OneTrust audit reassign scopes bulk update Reassign the scopes of an OneTrust audit by submitting an array of scope assignment objects. The request body is a bare JSON array of ScopesAssignmentRequest items. Returns an empty 200 response on success. Required: audit_id.
• List List all OneTrust search initiatives Search or list OneTrust compliance initiatives using filter criteria such as owner, organization, category, approvers, closedBy, or resolutionType. Returns: id, name. Max 50 results per page.
• Get Get single OneTrust initiative by ID Get a specific OneTrust initiative by id. Returns: id, name. Required: id.
• Update Update a OneTrust initiative by ID Update a specific OneTrust initiative by id. Returns the updated initiative including id, name, createdDate, workflow, stage, observationStartDT, observationEndDT, and ownerIds. Required: id, name, observationStartDT, observationEndDT, ownerIds.
• Create Create a OneTrust create Create a compliance document (policy, standard, procedure, or privacy notice) in OneTrust. Returns the UUID of the newly created document. Required: compliance_type.
• List List all OneTrust lists List OneTrust compliance documents (policies, standards, procedures, or privacy notices) by document type. Returns an array of policy records including policyId and createdDate. Required: compliance_type.
• List List all OneTrust details Get details for a specific OneTrust policy, standard, procedure, or privacy notice by compliance type and document id. Returns: id. Required: compliance_type, enterprise_policy_id.
• List List all OneTrust published versions Get the last published version of a OneTrust policy, standard, procedure, or privacy notice by the specified date. Returns: id. Required: compliance_type, enterprise_policy_id, date.
• Create Create a OneTrust document Add document attachments to a policy, standard, procedure, or privacy notice in OneTrust. Returns an empty 201 response on success. Required: compliance_type, policy_id, and a documentRequests body.
• Create Create a OneTrust versions create Create new versions of a policy, standard, or procedure in OneTrust by submitting an array of version definitions (content type, attachment, sequence, status). Returns an empty 201 response on success. Required: compliance_type, policy_id, and a body array with policyContentType, attachmentId, versionSequence, and status.
• Create Create a OneTrust issuelink issue Create a relationship between a OneTrust issue and a related record. Returns the created issue link object including id, linkTypeLabel, relatedEntityType, and relatedEntityId. Required: issue_id, linkTypeLabel, relatedEntityType, relatedEntityId.
• Get Get single OneTrust issuelink by ID Get issue relationships for a specific issue in OneTrust, retrieving relationship details between the issue and related records. Returns a paginated list of link records including Id, linkTypeLabel, relatedEntityType, and relatedEntityId. Required: id (the issue UUID obtained from the Get List of Issues API).
• Create Create a OneTrust issue Create a new issue in OneTrust. Returns the created issue object including id, name, orgGroupId, priority, description, and attributes. Required: name, orgGroupId, priority.
• Get Get single OneTrust issue by ID Get a single OneTrust issue by id. Returns the full issue object including id, name, priority, description, orgGroupId, attributes, createdDate, and deadline. Required: id.
• Update Update a OneTrust issue by ID Update all details for a specific OneTrust issue by id. Returns the updated issue including id, name, orgGroupId, priority, description, and attributes. Required: id, name, orgGroupId, priority, attributes. The attributes field must always be included — pass {} if empty, and include existing values to retain them.
• Update OneTrust issues bulk update Partially update a specific OneTrust issue's details. Returns the updated issue object including issueId, name, orgGroupId, priority, description, attributes, createdDate, and deadline. Required: issue_id. At least one body field must be provided.
• List List all OneTrust search issues Search OneTrust issues by filter criteria such as owner, or retrieve all issues. Returns an array of issue records with id, name, priority, deadline, createdDate, owner, orgGroupId, description, and attributes. Max 2000 results per page.
• Get Get single OneTrust issuetask by ID Get a list of all tasks for a specific issue in OneTrust. Returns: id. Required: id.
• List List all search controls control implementation attributes Search control implementation attributes in OneTrust by key terms and filters. Returns an array of attribute information records. Returns: id.
• Create Create a OneTrust control implementations page Search control implementations in OneTrust by key terms and filter criteria. Returns a paginated list where each record includes guid, number, controlName, controlIdentifier, frameworkName, categoryName, effectiveness, maturityName, status, primaryEntityName, primaryEntityType, createdDate, and lastModifiedDate. Max 2000 records per page.
• List List all OneTrust controls control implementations Get a single OneTrust control implementation by its unique identifier, including associated attributes, category, and framework details. Returns: guid, number, controlName, controlIdentifier, frameworkName, categoryName, status, effectiveness, maturityName, primaryEntityName, primaryEntityType, attributes, createdDate, lastModifiedDate. Required: guid.
• Action OneTrust controls control implementations attach attachment Attach a list of previously uploaded files to a specific control implementation in OneTrust. Files must first be uploaded via the Upload File API; the Id and Name values from that response are required in the request body. Returns an empty 204 response on success. Required: guid.
• Update OneTrust controls control implementations bulk update Update the attributes of a specific OneTrust control implementation by guid. Returns the updated control implementation including guid, number, controlName, controlIdentifier, frameworkName, categoryName, status, effectiveness, maturityName, primaryEntityName, primaryEntityType, attributes, createdDate, lastModifiedDate. Required: guid.
• Delete OneTrust controls control implementations bulk delete Delete a control implementation from an entity in OneTrust. Returns an empty 204 response on success. Required: guid, entityId.
• Create Create a OneTrust control Create a new control in the OneTrust Controls Library. Returns the id (UUID) of the newly created control record.
• Update Update a OneTrust control by ID Update the attributes of a specific control in the OneTrust Controls Library. Returns the updated control object including its id, name, identifier, status, frameworkName, categoryName, createdDate, and lastModifiedDate. Required: id.
• Delete Delete a OneTrust control by ID Delete an existing control from the onetrust Controls Library by id. Returns a 200 OK response on success. Required: id.
• Create Create a OneTrust controls page Search and retrieve a paginated list of controls in onetrust by key terms and filters. Returns control records including identifier, name, frameworkName, categoryName, status, createdDate, and lastModifiedDate.
• Create Create a OneTrust evidence task implementations page Search for evidence task implementations in OneTrust by entity, such as by assignee, control, and current interval status. Returns a paginated list with each record including id, number, name, primaryEntityName, currentIntervalStatus, collectionInterval, and createdDate. Optional sort and filter criteria may be supplied.
• Get Get single OneTrust controls evidence task implementation by ID Get a single evidence task implementation in OneTrust by id. Returns the full evidence implementation object including its id, number, name, primaryEntityName, primaryEntityType, collectionInterval, collectionStartDate, lastCollected, currentIntervalStatus, currentIntervalStartDate, currentIntervalEndDate, relatedControls, evidenceTaskType, createdDate, and lastModifiedDate. Required: id.
• Action Controls evidence task implementations attach attachment Attach files, a note, or a link to a specific evidence task implementation in OneTrust. For file attachments, the Id and Name values from the Upload File API response are required in the request body. Returns an empty 200 response on success. Required: evidence_task_implementation_id.
• Create OneTrust controls links bulk create Link an existing control to one or multiple related controls in the OneTrust Controls Library. Returns an array of created link objects.
• Create Create a OneTrust controls threat Create a new threat in the OneTrust Threat Library. Returns the unique identifier (guid) of the newly created threat as a UUID string. A JSON request body with threat details is required.
• Delete Delete a OneTrust controls threat by ID Delete an existing threat from the OneTrust Threat Library by id. Returns an empty 204 response on success. Required: id (the threat UUID, obtainable from the List Threats API).
• Create Create a OneTrust threats page Search for threats in OneTrust's Threat Library by key terms and filters. Returns a paginated list of threats with id, identifier, name, frameworkName, categoryName, status, createdDate, and lastModifiedDate. Max 2000 records per page.
• Create Create a OneTrust controls vulnerability Create a new vulnerability in OneTrust's Vulnerability Library. Returns the id (UUID) of the newly created vulnerability. A JSON request body with vulnerability details is required.
• Delete Delete a OneTrust controls vulnerability by ID Delete an existing vulnerability from the OneTrust Vulnerability Library by id. Returns an empty 204 response on success. Required: id.
• Create Create a OneTrust vulnerabilities page Retrieve a paginated list of OneTrust vulnerabilities filtered by key terms and search criteria. Returns vulnerability records including identifier, name, frameworkName, categoryName, status, createdDate, and lastModifiedDate for each matched entry. No required parameters; optionally supply a JSON request body with filter/search criteria and use the sort query parameter to control ordering.
• List List all OneTrust controls control entity types List all control entity source types in OneTrust. Returns each type's id, name, nameKey, enabled, and seeded status.
• List List all OneTrust related control entity types List related control entity types in OneTrust. Returns: id, name, nameKey, seeded, moduleName, schemaName.
• Get Get single OneTrust risk template template by ID Get a OneTrust risk template by its unique identifier. Returns the risk template details including templateId. Required: id. The templateId can be obtained from the OneTrust application URL on the Template Details screen.
• Create Create a OneTrust risks unlink Unlink one or more risks from a target entity in OneTrust. Removes the association between the specified risks and the entity without deleting the risks themselves; multiple risks can be unlinked in a single request. A RiskLinkRequest JSON body is required. Returns an empty 200 response on success.
• List List all OneTrust risk risk categories List all active risk categories in OneTrust. Returns: id, name, description. Only active risk categories are returned.
• List List all OneTrust risk settings matrixes Get the risk score matrix configuration in OneTrust. Returns the configuration object including its attributes with risk details for all impact levels, scores, and probability levels as defined by the upstream TechRiskCompliance-Risk_MatrixRiskScoreSettingDto schema.
• List List all OneTrust risk settings standards Get the standard risk score configuration in OneTrust. Returns all risk levels with their id, name, minimum score, and maximum score.
• Create Create a OneTrust risk Create a new risk in the OneTrust Risk Register. Returns the created risk including riskId, number, name, description, status, orgGroupId, createdDate, owners, approvers, and controlImplementationCount. The risk is created in the default state.
• Get Get single OneTrust risk by ID Get a single OneTrust risk by id. Returns: name, description. Required: id.
• Update Update a OneTrust risk by ID Update an existing OneTrust risk's details including name, description, owners, approvers, and other properties. Returns: name, description. Required: id.
• Delete Delete a OneTrust risk by ID Delete an existing OneTrust risk from the Risk Register by id. Returns an empty 204 response on success. Required: id.
• Search OneTrust risks search Retrieve risks linked to a specific entity type and entity ID in OneTrust. Returns: riskId, number, name, description, status, orgGroupId, createdDate, owners, approvers, controlImplementationCount. Required: risk_entity_type, entity_id.
• Update OneTrust risks partial update Partially modify an existing risk in the OneTrust Risk Register. The Managing organization assignment for risks setting must be enabled to pass values for orgGroupId. Returns an empty 204 response on success. Required: id.
• Approve OneTrust risks approve Approve a specified risk in OneTrust. Returns the risk information object including id, name, description, status, owners, approvers, and orgGroupId. Required: risk_id.
• Get Get single OneTrust risks page by ID Search and retrieve a paginated list of risks in OneTrust using optional search criteria in the request body and sorting options in the query. Returns a content array of risk records (each including number, name, description, orgGroupId, createdDate, and controlImplementationCount) along with pagination metadata (totalElements, totalPages, first, last, empty).
• List List all OneTrust risks risk entity types List all risk entity types in OneTrust from which a risk can be created. Returns: id, name, nameKey, enabled, seeded.
• List List all OneTrust risks source entity types List all entity types in OneTrust that can be automatically assigned as the source of a risk. Returns: id, name, nameKey, seeded, enabled.
• Update OneTrust risks upserts bulk update Create or update a risk in OneTrust via upsert — if a risk with matching attributes exists it is updated, otherwise a new risk is created. Returns the risk object including id, name, number, status, and createdDate. Required: matchAttributes and a risk request body.
• Create Create a OneTrust risk assign stage Assign an onetrust risk to a specific stage in its workflow. Moves the risk to the target stage; the risk must currently be in a valid stage for the transition to succeed. Returns the resulting workflow stage list object on success. Required: risk_id.
• Update OneTrust risk actions bulk update Perform a workflow action on a risk in OneTrust. Returns the updated risk information including id, status, owners, and approvers. Required: risk_id, action. This API is deprecated as of September 23, 2025.
• Update OneTrust risk approvers bulk update Update the approvers of a specific risk in OneTrust. Returns an empty 204 response on success. Required: risk_id. Risk approvers cannot be updated for a risk in the Monitoring stage of default risk workflows.
• Update OneTrust risk categories bulk update Update the categories associated with a specific risk in OneTrust by providing a list of category IDs. Returns an empty response on success (201 Created or 202 Accepted). Required: risk_id.
• Create Create a OneTrust risk control implementation Add control implementations to a risk in OneTrust. Returns a 201 response on success with no response body. Required: risk_id.
• Update OneTrust risk grant exceptions bulk update Grant an exception for a specific risk in OneTrust. Returns the updated risk information including its status, owners, and approvers. Required: risk_id.
• Update OneTrust risk owners bulk update Update the owners of a specific risk in OneTrust. Returns an empty 204 response on success. Required: risk_id. Risk owners cannot be updated for a risk in the Monitoring stage of default risk workflows.
• Update OneTrust risk reopens bulk update Reopen a specified risk in OneTrust. Returns the updated risk information including id, name, number, description, createdDate, orgGroupId, and controlImplementationCount. Required: risk_id.
• Update OneTrust risk request exceptions bulk update Request an exception for a specified risk in OneTrust. Returns the updated risk information object including id, name, status, description, owners, and approvers. Required: risk_id and a request body.
• Send OneTrust risk send backs bulk update Send back a specified risk in OneTrust to obtain additional information from the risk owner. Returns the updated risk object including id, status, owners, and approvers. Required: risk_id.
• Update OneTrust risk submits bulk update Submit a specified OneTrust risk for approval. Returns the updated risk information object including its id, number, name, status, createdDate, and controlImplementationCount. Required: risk_id.
• Create Create a OneTrust risk threat Add or replace a threat on a OneTrust risk. If a threat was previously assigned to the risk, it will be replaced with the newly specified threat. Returns an empty 201 response on success. Required: risk_id.
• Create Create a OneTrust risk vulnerability Add or replace vulnerabilities on a OneTrust risk. Any previously assigned vulnerabilities are replaced with the new ones specified in the request body. Returns an empty 201 response on success. Required: risk_id.
• List List all OneTrust courses List OneTrust awareness training courses with basic course details, optionally searching by title keyword. Returns: courseId, courseName, courseNameKey. This API was deprecated as of December 5, 2025.
• Create Create a OneTrust enrollment Enroll users into a specific OneTrust awareness training course. Returns a UUID request ID confirming the enrollment request has been accepted. Required: courseId, users. This API is deprecated as of December 5, 2025.
• List List all OneTrust enrollment assignee enrollment progreses Retrieve a user's enrollment status and progress for an OneTrust awareness training course. This API is deprecated as of December 5, 2025. Returns: languageId, languageName, languageNameKey, status, progress, courseId, score, completedDT. Required: enrollment_assignee_id.
• Delete Delete a OneTrust enrollments enrollment assignee by ID Unenroll a user from a specific course in OneTrust using the enrollment assignee id. Returns an empty 204 response on success. Required: id (the enrollmentAssigneeId, retrievable via the Get Enrollment Details API). This API is deprecated as of December 5, 2025.
• Get Get single OneTrust enrollments assignment by ID Get OneTrust awareness training enrollment details for all courses by submitting filter criteria. Returns enrollment records including enrollmentAssigneeId, assigneeId, courseId, status, score, deadline, assignedDate, completedDate, languageId, and organization. Required: field, operator, value. Deprecated as of December 5, 2025; max 2000 per page.
• Create Create a OneTrust contracts add Create a new vendor contract in OneTrust. Returns the contractId (UUID) of the newly created contract. Required: name, status, agreementCreatedDate, vendorId.
• List List all OneTrust contracts schemas List contract attribute schemas in OneTrust, retrieving details such as attribute name, ID, and associated options for each contract attribute. Returns: id, name, nameKey, description, descriptionKey, fieldName, mappedFieldName, enabled, required, readOnly, encrypted, allowOther, baseAttribute, responseType, formula, optionType, optionAllowed, schemaId, schemaName, options, referenceCategories,…
• List List all OneTrust contracts types List all contract types in OneTrust. Returns: id, name, nameKey, enabled, seeded.
• Search OneTrust vendor contracts search Search OneTrust vendor contracts by key terms and filters for a specific vendor. Returns: content, empty, first, last, number, numberOfElements, size, totalElements, totalPages, redacted, sort, pageable. Required: vendor_id.
• Delete Delete a OneTrust vendor contract by ID Delete an existing OneTrust vendor contract by id. Returns an empty 204 response on success. Required: id.
• Update OneTrust vendor contracts bulk update Update an existing OneTrust vendor contract with full contract details. Returns: id, name, vendorId, vendorName, orgGroupId, attachments, status, agreementCreatedDate, contractTypeId, contractTypeName, contractTypeNameKey, approvedDate, expirationDate, contractOwnerId, contractOwner, vendorContact, approvers, note, cost, currency, url, schemaId, attributeValues, viewOnly, statusKey. Required: contract_id, vendor_id, name, status, agreementCreatedDate.
• List List all OneTrust contracts Get a single OneTrust vendor contract by its unique identifier. Returns: id, name, vendorId, vendorName, orgGroupId, attachments, status, agreementCreatedDate, contractTypeId, contractTypeName, contractTypeNameKey, approvedDate, expirationDate, contractOwnerId, contractOwner, vendorContact, approvers, note, cost, currency, url, schemaId, attributeValues, viewOnly, statusKey. Required: contract_id.
• List List all OneTrust vendor engagement schemas List OneTrust engagement schema attributes with details like name, ID, field mappings, response type, and configuration flags. Returns: id, name, nameKey, description, descriptionKey, fieldName, mappedFieldName, enabled, required, readOnly, encrypted, allowOther, baseAttribute, responseType, formula, optionType, optionAllowed, schemaId, schemaName, options, referenceCategories, responseMaxLength,…
• Get Get single OneTrust vendor engagement by ID Get Engagement. Returns: engagementId, number, name, orgGroupName, orgGroupId, type, startDate, endDate. Required: id.
• Update Update a OneTrust vendor engagement by ID Update Engagement. Returns: engagementId, number, name, orgGroupName, orgGroupId, type, startDate, endDate. Required: id, name.
• Delete Delete a OneTrust vendor engagement by ID Delete Engagement. Required: id.
• Update OneTrust vendor engagements partial update Modify Engagement. Returns: engagementId, number, name, orgGroupName, orgGroupId, type, startDate, endDate. Required: id.
• Update OneTrust engagement status bulk update Update the status of an existing engagement in OneTrust. Returns an empty 200 response on success. Required: engagement_id, status.
• Create Create a OneTrust vendor engagements search Search OneTrust vendor engagements by key terms and filters. Returns a paginated response with content (engagement records including engagementId, name, engagementStatus, riskLevel, vendor, and workflow), totalPages, and totalElements. Supports sorting by name or createdDate in ascending or descending order. Max 2000 records per page.
• Create Create a OneTrust vendor vendor engagement Create a new vendor engagement in OneTrust. Returns the created engagement including engagementId, name, type, startDate, endDate, vendor, workflow, engagementStatus, and risk fields. The engagement name must be 500 characters or less; if orgGroupId is omitted, the vendor's organization is assigned. Date attributes must follow YYYY-MM-DDTHH:MM:SSZ format. Required: name, vendor.
• List List all OneTrust SCIM v 2 groups List SCIM groups from your OneTrust account, where each group represents a unique role-organization combination. Returns: schemas, id, displayName, members, meta. Max 25 groups per page.
• Get Get single OneTrust SCIM v 2 group by ID Get a single SCIM group by id in OneTrust, including the created date, last modified date, and list of users within the group. Returns: schemas, id, displayName, members, meta. Required: id.
• Update Update a OneTrust SCIM v 2 group by ID Fully update a OneTrust SCIM group's details and membership by id, replacing the existing member list with the new one provided in the request. If no members are specified, all existing members are removed. Returns: schemas, id, displayName, members, meta. Required: id.
• Update OneTrust SCIM v 2 groups partial update Partially update a OneTrust SCIM group's details and/or membership by id using SCIM PATCH operations. Supports adding, replacing, or removing specific attributes such as displayName and members without sending the full resource. Returns an empty 204 response on success. Required: id.
• List List all OneTrust SCIM v 3 groups List user groups in OneTrust via SCIM 2.0, with optional filtering on displayName using eq or co operators. Returns: schemas, id, displayName, members, meta. Members are excluded from the response by default.
• Create Create a OneTrust SCIM v 3 group Create a user group in OneTrust via SCIM 2.0. Returns: schemas, id, displayName, members, meta. Required: schemas, displayName.
• Get Get single OneTrust SCIM v 3 group by ID Get a single user group in OneTrust by id. Returns: schemas, id, displayName, members, meta. Members are excluded from the response by default. Required: id.
• Update Update a OneTrust SCIM v 3 group by ID Update a OneTrust SCIM v3 user group by id, fully replacing group details and membership. Returns: schemas, id, displayName, members, meta. Required: id, schemas, displayName. Omitting members removes all existing members from the group.
• Update OneTrust SCIM v 3 groups partial update Partially update a OneTrust SCIM v3 user group's details and/or group membership using SCIM PATCH operations. Returns an empty 204 response on success. Required: id, Operations.
• Delete Delete a OneTrust SCIM v 3 group by ID Delete a OneTrust SCIM user group by id. This API is intended for provisioning and managing users from an Identity Provider using the SCIM standard. Returns an empty 204 response on success. Required: id.
• List List all OneTrust SCIM v 2 users List OneTrust SCIM v2 users with details including created date, last modified date, name, and email. Returns: schemas, id, externalId, userName, name, emails, active, userType, division, employeeNumber, department, manager, title, roles, organization, groups, meta. Supports SCIM filters on id, externalId, email, emails, givenName, familyName, userType, and active.
• Create Create a OneTrust SCIM v 2 user Create a new OneTrust SCIM v2 user and associate them with a configured organization and role. Returns the created user including id, userName, name, emails, active, and meta. If roles or organization are omitted, defaults from User Provisioning settings are applied. Required: userName.
• Get Get single OneTrust SCIM v 2 user by ID Get a single OneTrust SCIM v2 user by id. Returns the full user object including id, userName, emails, name, groups, and meta. Required: id.
• Update Update a OneTrust SCIM v 2 user by ID Fully update all attributes for an OneTrust SCIM v2 user by id. Returns the updated user including id, userName, name, emails, active, and meta. Attributes not included in the request are replaced with null. Required: id, userName.
• Update OneTrust SCIM v 2 users partial update Partially update an OneTrust SCIM v2 user by id to activate, deactivate, or modify user attributes. Returns the updated user including id, userName, name, emails, active, and meta. Modifiable attributes include givenName, familyName, externalId, active, division, userType, employeeNumber, department, manager, and title. Required: id.
• Delete Delete a OneTrust SCIM v 2 user by ID Delete a OneTrust SCIM v2 user by id. Returns an empty 204 response on success. Required: id. The Delete User feature is not available at this time per the OneTrust API documentation.
• List List all OneTrust SCIM v 3 users List OneTrust SCIM v3 users with details such as created date, last modified date, name, and email. Returns: schemas, id, externalId, userName, name, emails, active, userType, title, division, department, employeeNumber, manager, roles, organization, groups, meta. Supports SCIM filter syntax on id, externalId, email, emails, givenName, familyName, userType, and active attributes using eq, co, sw,…
• Create Create a OneTrust SCIM v 3 user Create a OneTrust SCIM v3 user and associate them with a configured organization and role. Returns: schemas, id, externalId, userName, name, emails, active, userType, title, division, department, employeeNumber, manager, roles, organization, groups, meta. Required: userName. If roles or organization are omitted, defaults from the User Provisioning screen in Global Settings are applied.
• Get Get single OneTrust SCIM v 3 user by ID Get a single OneTrust SCIM v3 user by id, including created date, emails, and user group memberships. Returns: schemas, id, externalId, userName, name, emails, active, userType, title, division, department, employeeNumber, manager, roles, organization, groups, meta. Required: id.
• Update Update a OneTrust SCIM v 3 user by ID Fully update a OneTrust SCIM v3 user by replacing all attributes. Returns the updated user resource including id, externalId, active, givenName, familyName, emails, roles, and organization. Required: id. Any attributes omitted from the request body are replaced with null; retrieve the latest record via Get User first to avoid unintended data loss.
• Update OneTrust SCIM v 3 users partial update Partially update a SCIM v3 user in OneTrust to activate, deactivate, or modify specific user attributes without replacing the full record. Returns the updated user object including id, externalId, name, emails, active, roles, organization, and meta. Required: id. When no path is provided in the body, supply a full JSON body of attributes to update.
• List List all OneTrust access v 1 user groups List user groups in OneTrust with support for filtering and sorting. Returns: groupId, name, description, createdDate, lastModifiedDate. Max 2000 records per page.
• Create Create a OneTrust access v 1 user group Create a new user group in OneTrust. Returns: groupId, name, description, createdDate, lastModifiedDate. Required: name.
• Update Update a OneTrust access v 1 user group by ID Update the name and description of an existing OneTrust user group by id. Returns: groupId, name, description, createdDate, lastModifiedDate. Required: id.
• Delete Delete a OneTrust access v 1 user group by ID Delete an existing OneTrust user group by its unique identifier. Returns an empty 204 response on success. Required: id.
• Create OneTrust access v 1 user groups create member Add users as members to a specific OneTrust user group. The userId values of the users to add are provided in the request body as a comma-separated list. Returns a 201 Created response with no body on success. Required: user_group_id, userId.
• List List all OneTrust access v 2 user groups List user groups in OneTrust with support for filtering and sorting. Returns: id, name, description, createdDate, lastModifiedDate. Max 2000 records per page.
• Create Create a OneTrust access v 2 user group Create a new user group in OneTrust with a specified name and description. Returns: id, name, description, createdDate, lastModifiedDate. Required: name.
• Get Get single OneTrust access v 2 user group by ID Get a specific OneTrust user group by its unique identifier. Returns: id, name, description, createdDate, lastModifiedDate. Required: id.
• Update Update a OneTrust access v 2 user group by ID Update the attributes of an existing OneTrust user group by its unique identifier. Returns: id, name, description, createdDate, lastModifiedDate. Required: id.
• Delete Delete a OneTrust access v 2 user group by ID Delete an existing OneTrust user group by its unique identifier. Returns an empty 204 response on success. Required: id.
• Create OneTrust access v 2 user groups create member Add multiple users to a OneTrust user group in bulk. Returns an empty 201 response on success. Required: group_id, userId.
• List List all OneTrust user group v 1 members List members of a specific OneTrust user group. Returns: memberId, fullName, email, enabled, createdBy, createdDate. Required: user_group_id. Max 2000 records per page; results default to sorting by fullName ascending.
• Delete OneTrust user group v 1 members bulk delete Remove multiple users as members from a specific OneTrust user group. The userIds of the users to remove are specified as a comma-separated list in the request body. Returns an empty 204 response on success. Required: user_group_id, userId.
• List List all OneTrust user group v 2 members List members of a OneTrust user group with pagination support. Returns: memberId, name, email, enabled. Required: group_id.
• Delete OneTrust user group v 2 members bulk delete Remove multiple users from a OneTrust user group in bulk. Returns an empty 204 response on success. Required: group_id.
• Create Create a OneTrust user group v 2 member Add a single user to a OneTrust user group by specifying both the group and member identifiers in the path. The user inherits the role and organization configured for that user group. Returns an empty 201 response on success. Required: group_id, member_id.
• Delete Delete a OneTrust user group v 2 member by ID Remove a single user from a OneTrust user group by specifying the group and the member identifier. Returns an empty 204 response on success. Required: group_id, id.
• List List all OneTrust consentmanager v 1 datasubject profiles List all data subject profiles in OneTrust. Returns: Id, Language, Identifier, LastUpdatedDate, CreatedDate, DataElements, TestDataSubject. Include `properties=ignoreCount` for performance on large datasets; `since` and `updatedSince` are mutually exclusive.
• Delete OneTrust consentmanager v 2 datasubject profiles bulk delete Delete up to 100 purposes from one data subject, or one purpose from up to 100 data subjects in OneTrust. By default, related data subject transactions are removed from the database; set retainTransactions to true to keep them. Returns a confirmation string. Required: identifier, purposes.
• List List all OneTrust consent v 4 datasubject profiles List all purpose details for all data subjects in OneTrust, filtered by a mandatory date range. Returns: transactionGuid, guid, purposeGuid, purposeVersion, expiryDate, topics, customPreferences, transactionType, attributes, purposeNote, autoGenerated, purposeAttachments, receiptId, collectionPointUUID, identifier, consentCreationDate, interactionDate, collectionPointAttributes. Required:…
• Get Get single OneTrust consent v 4 datasubject profile by ID Get purpose details for a specific data subject and purpose in OneTrust. Returns: transactionGuid, guid, purposeGuid, purposeVersion, expiryDate, topics, customPreferences, transactionType, attributes, purposeNote, autoGenerated, purposeAttachments, receiptId, collectionPointUUID, identifier, consentCreationDate, interactionDate, collectionPointAttributes. Required: id.
• List List all OneTrust preference v 3 datasubject profile List data subject profiles in OneTrust. Returns: Id, Language, Identifier, LastUpdatedDate, CreatedDate, DataElements, TestDataSubject, linkToken. Deprecated — do not adopt if not already in use.
• List List all OneTrust consentmanager v 2 purposes List OneTrust consent purpose versions. Returns: guid, name, description, version, purposeStatus, purposeType, consentLifeSpan, implicitConsentLifeSpan, defaultConsentStatus, createdDate, lastModifiedDate, publishedDate, retireOnDate, createdBy, lastModifiedBy, publishedBy, externalReference.
• Get Get single OneTrust consentmanager v 2 purpose by ID Get a single OneTrust consent Purpose by id. Returns the Purpose including guid, name, description, version, purposeStatus, purposeType, attributes, preferences, createdDate, lastModifiedDate, and publishedDate. Required: id.
• List List all OneTrust consentmanager v 1 collectionpoints List OneTrust consent collection points with optional filters by name, type, status, consent type, purpose, data element, or organization. Returns each collection point with id, name, version, status, collectionPointType, consentType, purposes, notices, dataElements, createdDate, and lastModifiedDate. Max 100 records per page.
• Create Create a OneTrust consentmanager v 1 collectionpoint Create a new OneTrust consent collection point in Draft status (version 1). Returns: id, name, version, status, collectionPointType, consentType, createdDate, lastModifiedDate, purposes, notices, dataElements, organizationId. Required: one of PurposeId, PurposeIds, or PurposeIdsWithVersion. If EnablePrimaryIdentifier is true, PrimaryIdentifierType is also required.
• Update Update a OneTrust consentmanager v 1 collectionpoint by ID Update an existing OneTrust Collection Point by id. The Collection Point must be in Draft status before calling this API; if it is Active, create a new version first. One of PurposeId, PurposeIds, or PurposeIdsWithVersion must be included in the request body. Returns an empty response on success. Required: id.
• Update OneTrust consentmanager v 1 collectionpoints bulk update Disable or enable a OneTrust Collection Point by setting the value query parameter. Set value to true to disable all versions from ingesting receipts, or false to restore the previous status. Returns an empty 200 response on success. Required: collectionpoint_id. ADMIN_UPDATE and NOTIFICATION_OPT_OUT collection point types cannot be disabled.
• List List all OneTrust consentmanager v 2 collectionpoints List OneTrust collection points using the v2 API, or retrieve a single collection point by its id query parameter. Returns: id, name, version, status, collectionPointType, createdDate, lastModifiedDate, activationDate. By default all versions are returned with the active version listed first; use version and status to narrow results. Max 100 results per page.
• Search OneTrust data governance v 1 catalogs search Search OneTrust Data Use Governance catalog entries by key terms and filters. Returns: facets, documents. Returns up to 100,000 results; for larger volumes use the V2 catalog search API.
• Search OneTrust data governance v 2 catalogs search Search OneTrust Data Governance catalog results by key terms and filters. Returns search documents including id, documentType, name, jobId, source, along with facets and pagination metadata. Designed for large volumes; use the continuationToken from each response to fetch subsequent pages. The request body is required.
• List List all OneTrust data element name pages List personal data elements linked to a contextual entity relationship in OneTrust, identified by entity type name. Returns each linked personal data record with id, dataElement, dataCategories, dataSubjectType, source, dateLinked, and hidden. Required: contextual_link_id, entity_type_name.
• List List all OneTrust data element ID pages List personal data linked to a contextual relationship by entity type ID in OneTrust. Returns: id, dataElement, dataCategories, dataSubjectType, dateLinked, hidden. Required: contextual_link_id, entity_type_id.
• Create Create a OneTrust assessment v 3 assessment Launch a new assessment in OneTrust, creating it with the details provided in the request body and assigning it to the indicated respondents. Returns a UUID string identifying the newly created assessment. The request body specifies respondents, respondentCreationType, userAssignmentMode, creationSource, and a template identifier (templateId or templateRootVersionId); optional inventoryDetails…
• Create Create a OneTrust datadiscovery v 3 requestqueue Add Targeted Data Discovery results that include unstructured data to a request in OneTrust. Returns a 200 OK response with no body on success. Required: requestqueue_id.
• Create Create a OneTrust datasubject v 2 requestqueue subqueue Create a subqueue for an existing request queue in OneTrust. Returns: Id, Identifier, Language, CreatedDate, LastUpdatedDate, DataElements, TestDataSubject. Required: requestqueue_id.
• List List all OneTrust datasubject v 3 subtasks List OneTrust subtasks by filter criteria using a POST request body. Returns: subTaskId, requestTypeName, subjectTypeName, taskName, subtaskDateCreated, subtaskDateUpdated, requestDeadline, requestDateCreated. Requires a filter criteria request body. Max page size 500.
• Create Create a OneTrust entity control implementations page List control implementations for a specific entity in OneTrust — such as assets, processing activities, legal entities, risks, or vendors. Returns: id, modelSource. Required: entity_id.
• Create Create a OneTrust controls v 2 threat Create multiple new threats in the OneTrust Threat Library by submitting a JSON array of threat objects. Returns a list of added threat identifiers (guid). Required: a JSON array body of threat definitions to add to the library.
• Update OneTrust controls v 2 threats bulk update Update attributes of multiple threats in the OneTrust Threat Library. Returns an array of updated threat objects including guid, identifier, name, status, frameworkName, categoryName, createdDate, and lastModifiedDate. Required: body (array of threat update requests, each requiring guid).
• Update OneTrust controls v 2 vulnerabilities bulk update Update attributes of vulnerabilities in the OneTrust Vulnerability Library by submitting a JSON array of update requests. Returns an array of updated vulnerability objects including identifier, name, status, frameworkName, categoryName, createdDate, and lastModifiedDate.
• Create Create a OneTrust risk v 3 risk Create a new risk in the OneTrust Risk Register. The risk is created in the default state as a standalone risk. Returns the UUID identifier of the newly created risk. Requires a JSON request body with risk details.

No tools match your search.