OneTrust

OneTrust Users V2 API

APIs to manage users and their memberships and access levels.

Documentation GitHub OpenAPI

Business capability

Identity & Access Management BC-620.20

Operations 14

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/access/v2/users List all users in the account · Get List of Users #

Ask an LLM

“Who are all the users in my OneTrust account?”

“Can I page through the account's user list and sort it?”

Tell an agent

List every user in my account, sorted by {sort}.

Show page {page} of the account users with {size} per page.

POST /api/access/v2/users Create a new user in the account · Create User #

Ask an LLM

“How do I add a new person as a user in my privacy account?”

“Can I create a user without sending them a notification email?”

Tell an agent

Add a user named {firstName} {lastName} with email {email}.

Create user {email} ({firstName} {lastName}) whose access expires at {expirationDateTime}.

GET /api/access/v2/users/{userId} Get one user's account details · Get User #

Ask an LLM

“What details are stored for a single user in my account?”

“Can I look up one account user by their user ID?”

Tell an agent

Show the account details for user {userId}.

Look up user {userId} and tell me their name, email and access levels.

PUT /api/access/v2/users/{userId} Update a user's name and access details · Update User #

Ask an LLM

“How do I change a user's name or expiration date in the account?”

“Can I mark an existing user as internal or external?”

Tell an agent

Rename user {userId} to {firstName} {lastName}.

Set the access expiration of user {userId} ({firstName} {lastName}) to {expirationDateTime}.

GET /api/access/v2/users/{userId}/access-levels List the roles assigned to a user · Get User Roles #

Ask an LLM

“Which roles does a particular user hold?”

“What access levels has this user been granted across organizations?”

Tell an agent

List the roles assigned to user {userId}.

Tell me which organizations and roles user {userId} has.

POST /api/access/v2/users/{userId}/access-levels Grant a role to a user in an organization · Add User Role #

Ask an LLM

“How do I give a user an additional role?”

“Can I grant someone a role scoped to a specific organization?”

Tell an agent

Grant role {roleId} in organization {organizationId} to user {userId}.

Give user {userId} the {roleId} role for organization {organizationId}.

DELETE /api/access/v2/users/{userId}/access-levels Remove a role from a user · Remove User Role #

Ask an LLM

“How do I take a role away from a user?”

“Can I revoke a user's role in just one organization?”

Tell an agent destructive · confirm first

Remove role {roleId} in organization {organizationId} from user {userId}.

Revoke user {userId}'s {roleId} role in organization {organizationId}.

PATCH /api/access/v2/users/{userId}/default-organization Change a user's default organization · Modify User Default Organization #

Ask an LLM

“How do I change which organization a user lands in by default?”

“Does the user need a role in an organization before it can be their default?”

Tell an agent

Make organization {organizationId} the default for user {userId}.

Switch user {userId}'s default organization to {organizationId}.

GET /api/scim/v2/Users List users through the SCIM provisioning endpoint · Get List of Users #

Ask an LLM

“How does my identity provider list users over SCIM?”

“Can a SCIM sync page through users with a start index and count?”

Tell an agent

List SCIM-provisioned users starting at index {startIndex}, {count} at a time.

Fetch the SCIM user list with created and last modified dates.

POST /api/scim/v2/Users Provision a user from an identity provider via SCIM · Create User #

Ask an LLM

“How do I provision a new user from my identity provider over SCIM?”

“Can a SCIM-created user be assigned roles and groups at creation?”

Tell an agent

Provision SCIM user {userName} with emails {emails}.

Create a SCIM user {userName} with roles {roles} and title {title}.

GET /api/scim/v2/Users/{id} Get a SCIM user and their groups · Get User #

Ask an LLM

“Which SCIM groups does a provisioned user belong to?”

“What does the SCIM record for one provisioned user look like?”

Tell an agent

Get the SCIM record for user {id}.

Show which SCIM groups provisioned user {id} belongs to.

PUT /api/scim/v2/Users/{id} Replace all attributes of a SCIM user · Update User #

Ask an LLM

“How do I fully overwrite a provisioned user's attributes over SCIM?”

“Can a SCIM full replace change a user's userName and emails together?”

Tell an agent

Replace the full SCIM record of user {id} with userName {userName} and emails {emails}.

Overwrite SCIM user {id} so that active is {active} and title is {title}.

DELETE /api/scim/v2/Users/{id} Delete a SCIM user (not currently available) · Delete User #

Ask an LLM

“Can I delete a provisioned user through the SCIM endpoint?”

“Is SCIM user deletion supported right now?”

Tell an agent destructive · confirm first

Delete SCIM user {id}.

Remove provisioned user {id} through the SCIM delete endpoint.

PATCH /api/scim/v2/Users/{id} Activate, deactivate or patch a SCIM user · Modify User #

Ask an LLM

“How do I deactivate a user from my identity provider over SCIM?”

“Can I partially update a SCIM user instead of replacing them?”

Tell an agent

Deactivate SCIM user {id}.

Apply the SCIM patch operations {Operations} to user {id}.

Documentation

https://developer.onetrust.com/onetrust/reference/attribute-management

https://developer.onetrust.com/onetrust/reference/activity-log

https://developer.onetrust.com/onetrust/reference/preferences-v2

https://developer.onetrust.com/onetrust/reference/banner

https://developer.onetrust.com/onetrust/reference/consent-receipts

https://developer.onetrust.com/onetrust/reference/applications

https://developer.onetrust.com/onetrust/reference/categorizations

https://developer.onetrust.com/onetrust/reference/domain-data

https://developer.onetrust.com/onetrust/reference/preferences

https://developer.onetrust.com/onetrust/reference/mobile-app-data

https://developer.onetrust.com/onetrust/reference/privacy-notice-v2

https://developer.onetrust.com/onetrust/reference/collection-points

https://developer.onetrust.com/onetrust/reference/catalog-search-v1

https://developer.onetrust.com/onetrust/reference/classification

https://developer.onetrust.com/onetrust/reference/custom-scan

https://developer.onetrust.com/onetrust/reference/carbon-management

https://developer.onetrust.com/onetrust/reference/audit-records

https://developer.onetrust.com/onetrust/reference/bulk-export

https://developer.onetrust.com/onetrust/reference/attachments

https://developer.onetrust.com/onetrust/reference/system-credentials

https://developer.onetrust.com/onetrust/reference/inventory-relationships-v2

https://developer.onetrust.com/onetrust/reference/model-management

https://developer.onetrust.com/onetrust/reference/tasks

https://developer.onetrust.com/onetrust/reference/groups-v2

https://developer.onetrust.com/onetrust/reference/assessment-actions

https://developer.onetrust.com/onetrust/reference/inventory

https://developer.onetrust.com/onetrust/reference/inventory-1

https://developer.onetrust.com/onetrust/reference/drop-management

https://developer.onetrust.com/onetrust/reference/incidents

https://developer.onetrust.com/onetrust/reference/document-controller

https://developer.onetrust.com/onetrust/reference/audits

https://developer.onetrust.com/onetrust/reference/initiatives

https://developer.onetrust.com/onetrust/reference/document-attachments

https://developer.onetrust.com/onetrust/reference/issues

https://developer.onetrust.com/onetrust/reference/control-implementations

https://developer.onetrust.com/onetrust/reference/training

https://developer.onetrust.com/onetrust/reference/contracts

Specifications

https://raw.githubusercontent.com/api-evangelist/onetrust/refs/heads/main/openapi/onetrust-users-v2-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/onetrust:onetrust-users-v2-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Onetrust Users V2 API
  version: '1.0'
  contact:
    name: OneTrust Support
    url: https://my.onetrust.com/s/contactsupport
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  description: 'Operations tagged Users V2 across 2 of this provider''s published API definitions: onetrust-platform-access-management-openapi.json, onetrust-platform-user-provisioning-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{hostname}
  variables:
    hostname:
      default: hostname
      description: The OneTrust hostname such as app.onetrust.com, app-eu.onetrust.com, app-de.onetrust.com, app-uk.onetrust.com, app-apac.onetrust.com, trial.onetrust.com, or uat.onetrust.com.
tags:


# --- truncated at 32 KB (70 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/onetrust/refs/heads/main/openapi/onetrust-users-v2-api-openapi.yml