> 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/human-access/open-api-and-mcp/api-reference/user-groups.md).

# User Groups

Endpoints for listing user groups, reading members and default or hidden apps and managing group membership.

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="https://www.cakewalk.security/docs/human-access/open-api-and-mcp/api-reference/user-groups/get-usersgroups.md">/{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="https://www.cakewalk.security/docs/human-access/open-api-and-mcp/api-reference/user-groups/get-usersgroups-usersgroupid.md">/{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="https://www.cakewalk.security/docs/human-access/open-api-and-mcp/api-reference/user-groups/get-usersgroups-usersgroupid-defaultworkapps.md">/{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="https://www.cakewalk.security/docs/human-access/open-api-and-mcp/api-reference/user-groups/get-usersgroups-usersgroupid-hiddenworkapps.md">/{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="https://www.cakewalk.security/docs/human-access/open-api-and-mcp/api-reference/user-groups/get-usersgroups-usersgroupid-users.md">/{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="https://www.cakewalk.security/docs/human-access/open-api-and-mcp/api-reference/user-groups/post-usersgroups-usersgroupid-users.md">/{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="https://www.cakewalk.security/docs/human-access/open-api-and-mcp/api-reference/user-groups/delete-usersgroups-usersgroupid-users-deletewithpost.md">/UsersGroups/{usersGroupId}/Users/DeleteWithPost</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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
