User groups

A user group is a named collection of users that you manage and assign together. Instead of granting workspace access one user at a time, you assign a group to a workspace once, and every member gains access with the role you choose.

User groups are created and managed through the Admin API.

• A group bundles users under a single name and description.
• You add or remove members by their user ID.
• You assign a group to a workspace with a role. Every current member of the group is provisioned into that workspace with that role.
• A group can be assigned to more than one workspace, and a user can belong to more than one group.

User groups sit alongside the existing access model:

• Organization: the top-level account that users belong to.
• Workspace: an isolated environment with its own members, API keys, and usage. Each member has a workspace role.
• User group: a convenience layer for assigning many users to a workspace at once, with a chosen role.

When you provision a group to a workspace, you set the workspace role applied to its members. See Organizations and workspaces for how workspace roles work, and Roles and RBAC for identifying roles by name or UUID.

1. Create a group.
2. Add members to the group.
3. Assign the group to a workspace with a role.

For the corresponding API calls, see User provisioning.