OneTrust

OneTrust User Groups V2 API

APIs to manage user groups and their memberships. Create groups to organize users, assign permissions collectively, add or remove members, and retrieve information about existing groups and their members.

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/user-groups List user groups · Get List of User Groups #

Ask an LLM

“Which user groups exist in my OneTrust access settings?”

“Can I filter and sort the list of user groups page by page?”

Tell an agent

List all user groups in my account.

List user groups matching filter {filters}, sorted by {sort}.

POST /api/access/v2/user-groups Create a user group · Create User Group #

Ask an LLM

“What do I need to set up a new user group for access management?”

“Can a new user group be given a description when it is created?”

Tell an agent

Create a user group named {name}.

Create a new user group called {name} described as {description}.

GET /api/access/v2/user-groups/{groupId} Get a user group · Get User Group #

Ask an LLM

“Where can I see the name and description of one specific user group?”

“Can I look up a single user group by its ID?”

Tell an agent

Show me user group {groupId}.

Fetch the details of the user group with ID {groupId}.

PUT /api/access/v2/user-groups/{groupId} Rename or re-describe a user group · Update User Group #

Ask an LLM

“Can I rename an existing user group?”

“How can I change the description on a user group I already created?”

Tell an agent

Rename user group {groupId} to {name}.

Update user group {groupId} with name {name} and description {description}.

DELETE /api/access/v2/user-groups/{groupId} Delete a user group · Delete User Group #

Ask an LLM

“Can I permanently delete a user group I no longer need?”

“What happens when a whole user group is removed from access management?”

Tell an agent destructive · confirm first

Delete user group {groupId}.

Remove the user group with ID {groupId} entirely.

GET /api/access/v2/user-groups/{groupId}/access-levels List a user group's roles · Get User Group Roles #

Ask an LLM

“Which roles and organizations does a user group currently have?”

“Can I see what access levels are granted to a user group?”

Tell an agent

List the roles assigned to user group {groupId}.

Show the access levels for group {groupId}.

PUT /api/access/v2/user-groups/{groupId}/access-levels Swap a role on a user group · Update User Group Roles #

Ask an LLM

“Can I replace one role on a user group with a different role and organization?”

“How do I change a user group's role from one organization to another?”

Tell an agent

On user group {groupId}, replace role {currentRoleId} in org {currentOrganizationId} with role {newRoleId} in org {newOrganizationId}.

Swap group {groupId}'s role {currentRoleId} for {newRoleId}.

POST /api/access/v2/user-groups/{groupId}/access-levels Add a role to a user group · Add User Group Roles #

Ask an LLM

“Can I grant an additional role to a user group for a specific organization?”

“What is needed to give a user group a new access level?”

Tell an agent

Grant role {roleId} in organization {organizationId} to user group {groupId}.

Add role {roleId} to group {groupId}.

DELETE /api/access/v2/user-groups/{groupId}/access-levels Remove roles from a user group · Remove User Group Roles #

Ask an LLM

“Can I strip the roles off a user group without deleting the group?”

“Is it possible to revoke a user group's access levels?”

Tell an agent destructive · confirm first

Remove the roles from user group {groupId}.

Revoke all access levels on group {groupId}.

GET /api/access/v2/user-groups/{groupId}/members List users in a user group · Get List of Users in User Group #

Ask an LLM

“Who are the members of a particular user group?”

“Can I page through the users that belong to a group?”

Tell an agent

List the members of user group {groupId}.

Show page {page} of users in group {groupId}.

POST /api/access/v2/user-groups/{groupId}/members Add many users to a user group · Add Multiple Users to User Group #

Ask an LLM

“Can I add several users to a user group in one bulk call?”

“What is the fastest way to put a batch of people into a group?”

Tell an agent

Add users {members} to user group {groupId} in bulk.

Bulk-add a list of members to group {groupId}.

DELETE /api/access/v2/user-groups/{groupId}/members Remove many users from a user group · Remove Multiple Users from User Group #

Ask an LLM

“Can I bulk-remove several users from a group at once?”

“Is there a way to take a batch of people out of a user group together?”

Tell an agent destructive · confirm first

Remove users {members} from user group {groupId} in bulk.

Bulk-remove a list of members from group {groupId}.

POST /api/access/v2/user-groups/{groupId}/members/{memberId} Add one user to a user group · Add User to User Group #

Ask an LLM

“Can I add a single user to a user group?”

“What does it take to put just one person into a group?”

Tell an agent

Add user {memberId} to user group {groupId}.

Put member {memberId} into group {groupId}.

DELETE /api/access/v2/user-groups/{groupId}/members/{memberId} Remove one user from a user group · Remove User from User Group #

Ask an LLM

“Can I take a single person out of a user group?”

“Does removing one member from a group delete the user account?”

Tell an agent destructive · confirm first

Remove user {memberId} from user group {groupId}.

Drop member {memberId} from group {groupId}.

OneTrust User Groups V2 API

Operations 14

Documentation

Specifications

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification