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

Endpoint	Method	Description
/UsersGroups	GET	Returns a list of all user groups, including metadata like name, external ID, and sync source.
/UsersGroups/{usersGroupId}	GET	Retrieves metadata for a specific user group, including name and integration source.
/UsersGroups/{usersGroupId}/DefaultWorkApps	GET	Lists the work apps that are default-assigned to users via group membership.
/UsersGroups/{usersGroupId}/HiddenWorkApps	GET	Lists work apps that are associated with the group but hidden from end-user views.
/UsersGroups/{usersGroupId}/Users	GET	Lists the users that are members of the specified group.
/UsersGroups/{usersGroupId}/Users	POST	Adds user(s) to a specified user group.
/UsersGroups/{usersGroupId}/Users/{userId}	DELETE	Removes a single user from a specified user group.