> For the complete documentation index, see [llms.txt](https://www.cakewalk.security/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.cakewalk.security/docs/open-api-and-mcp/api-reference/user-groups.md).

# User Groups

The User Groups endpoints allow you to retrieve and inspect logical groupings of users, typically synced from identity providers or directory systems. These groups often reflect teams, departments, or organizational roles, and they provide useful context for understanding and managing inherited access to applications.

These endpoints are commonly used to:

* Investigate which users belong to which groups
* Understand the default vs hidden app access granted via group membership
* Support group-based governance, reporting, or offboarding flows

***

### 📘 User Groups Endpoints

<table><thead><tr><th width="256.47265625">Endpoint</th><th width="124.71484375">Method</th><th width="97.9453125">Version<select><option value="Jmnx3jlUY0kQ" label="v1" color="blue"></option></select></th><th>Description</th></tr></thead><tbody><tr><td><a href="/pages/2zuluqPzh9dSAtkQbjoL">/{version}/UsersGroups</a></td><td>GET</td><td><span data-option="Jmnx3jlUY0kQ">v1</span></td><td>Returns a list of all user groups, including metadata like name, external ID, and sync source.</td></tr><tr><td><a href="/pages/TgZGb9JzLvyeawrcYqRE">/{version}/UsersGroups/{usersGroupId}</a></td><td>GET</td><td><span data-option="Jmnx3jlUY0kQ">v1</span></td><td>Retrieves metadata for a specific user group, including name and integration source.</td></tr><tr><td><a href="/pages/258jUynXQsgflnXs4Z4A">/{version}/UsersGroups/{usersGroupId}/DefaultWorkApps</a></td><td>GET</td><td><span data-option="Jmnx3jlUY0kQ">v1</span></td><td>Lists the work apps that are default-assigned to users via group membership.</td></tr><tr><td><a href="/pages/vygS9otwlqR0agmmnwKo">/{version}/UsersGroups/{usersGroupId}/HiddenWorkApps</a></td><td>GET</td><td><span data-option="Jmnx3jlUY0kQ">v1</span></td><td>Lists work apps that are associated with the group but hidden from end-user views.</td></tr><tr><td><a href="/pages/Nj1bDFSvW6loqZ9olsv6">/{version}/UsersGroups/{usersGroupId}/Users</a></td><td>GET</td><td><span data-option="Jmnx3jlUY0kQ">v1</span></td><td>Lists the users that are members of the specified group.</td></tr><tr><td><a href="/pages/0gK4qD1LJLHODiEJksgX">/{version}/UsersGroups/{usersGroupId}/Users</a></td><td>POST</td><td><span data-option="Jmnx3jlUY0kQ">v1</span></td><td>Adds user(s) to a specified user group.</td></tr><tr><td><a href="/pages/z7nIyd8mlrrv6YJaDjcq">/{version}/UsersGroups/{usersGroupId}/Users/{userId}</a></td><td>DELETE</td><td><span data-option="Jmnx3jlUY0kQ">v1</span></td><td>Removes a single user from a specified user group.</td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://www.cakewalk.security/docs/open-api-and-mcp/api-reference/user-groups.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.