Skip to main content

Groups

Groups let you organize users into logical collections - by team, department, project, or any other criteria. Roles assigned to a group are inherited by all group members, simplifying permission management at scale.


How Groups Work

When you assign a role to a group, every member of that group automatically receives the role's permissions. When a user is removed from the group, they lose those permissions (unless the role is also directly assigned).


Managing Groups

Create a Group

  1. Go to /t/{tenantSlug}/portal/access-management/groups
  2. Click Create Group
  3. Enter group details:
FieldDescriptionExample
NameDisplay nameEngineering
SlugMachine-readable identifierengineering
DescriptionGroup purposeEngineering team members

Add Members

  1. Open the group
  2. Click Add Members
  3. Search and select users to add

Assign Roles to a Group

  1. Open the group
  2. Click the Roles tab
  3. Add roles that all group members should inherit

API Examples

# Create a group
curl -X POST https://your-domain.com/t/{tenantSlug}/api/v1/groups \
-H "Authorization: Bearer {admin_token}" \
-H "Content-Type: application/json" \
-d '{
"name": "Engineering",
"slug": "engineering",
"description": "Engineering team"
}'

# Add a user to a group
curl -X POST https://your-domain.com/t/{tenantSlug}/api/v1/groups/{groupId}/members \
-H "Authorization: Bearer {admin_token}" \
-H "Content-Type: application/json" \
-d '{"userId": "user-uuid"}'

# Assign a role to a group
curl -X POST https://your-domain.com/t/{tenantSlug}/api/v1/groups/{groupId}/roles \
-H "Authorization: Bearer {admin_token}" \
-H "Content-Type: application/json" \
-d '{"roleId": "role-uuid"}'

Permission Resolution

A user's effective permissions come from:

  1. Directly assigned roles - Roles assigned to the user
  2. Group-inherited roles - Roles assigned to groups the user belongs to

Use Cases

ScenarioGroups Setup
Team-based accessOne group per team (Engineering, Marketing, Sales)
Project-based accessOne group per project with project-specific roles
Department hierarchyGroups for departments, sub-groups for teams
Temporary accessAdd user to a group for temporary elevated access, remove later
OnboardingAdd new employee to their team's group - they inherit all needed roles