Create and manage groups that organize users by teams, departments, or functions. Groups are how you scale access management - instead of managing 50 individual users, you manage 5 groups.
Real-World Scenario
Situation: Your company is creating a new "Customer Analytics" team with 8 people. They need:
- Access to customer data domain
- Ability to create dashboards
- View-only access to production pipelines
- Shared team resources
Solution: Create "Customer Analytics" group → Assign roles to group → Add 8 users → Everyone gets consistent access instantly.
Quick Start Workflow
Step 1: Create the Group
POST /admin/api/groupsRequest:
{ "name": "Customer Analytics", "attributes": { "department": ["Analytics"], "manager": ["analytics-lead@company.com"], "description": ["Customer-facing analytics and reporting team"] }}Response: Save group-015
Step 2: Assign Roles to Group
PUT /admin/api/assign-client-rolesRequest:
{ "groupId": "group-015", "roles": [ "dashboard-creator", "pipeline-viewer", "customer-data-viewer" ]}Step 3: Add Users to Group
PUT /admin/api/users/user-201/assign-groupsRequest:
{ "groupIds": ["group-015"]}Repeat for all 8 team members.
Step 4: Verify Group Setup
GET /admin/api/groups/group-015Check: All users listed, roles assigned, attributes set.
Common Group Patterns
- By Team: Data Engineering, Analytics, ML Team
- By Function: Pipeline Admins, Dashboard Viewers, API Developers
- By Access Level: Power Users, Standard Users, Read Only
- By Project: Q1-Launch-Team, Migration-Project-2024
- By Environment: Prod-Access, Dev-Access, Staging-Access
APIs Used
POST /admin/api/groups- Create groupGET /admin/api/groups- List groupsGET /admin/api/groups/:groupId- Get detailsPUT /admin/api/groups/:groupId- Update groupDELETE /admin/api/groups/:groupId- Delete groupPUT /admin/api/assign-client-roles- Assign roles to group
Was this page helpful?