Groups & Sharing Guide

Groups let you organize users into teams that mirror your org structure. Use groups to:

• Organize by department - Create groups for HR, Finance, Ops, etc.
• Apply group-specific policies - Different safety rules for different teams
• Scope access to features - Control which capabilities each group can use

Create groups via the Admin Dashboard or API:

POST /api/groups
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "name": "HR Team",
  "description": "Human Resources department",
  "orgId": "org_abc123"
}

Response:

{
  "groupId": "grp_xyz789",
  "name": "HR Team",
  "description": "Human Resources department",
  "orgId": "org_abc123",
  "createdAt": "2024-01-15T10:30:00Z",
  "memberCount": 0
}

Add users to a group to grant them access:

POST /api/groups/:groupId/members
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "userId": "usr_abc123",
  "role": "member"  // or "admin" for group administrators
}

Users can view their group memberships:

GET /api/groups/my-groups
Authorization: Bearer YOUR_API_KEY

Response:

{
  "groups": [
    {
      "groupId": "grp_xyz789",
      "name": "HR Team",
      "role": "member",
      "joinedAt": "2024-01-10T08:00:00Z"
    },
    {
      "groupId": "grp_abc456",
      "name": "All Employees",
      "role": "member",
      "joinedAt": "2024-01-01T00:00:00Z"
    }
  ]
}

Apply different safety policies to different groups:

// Example: Finance team has stricter SSN blocking
POST /api/admin/policies
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "name": "Block All SSNs (Finance Only)",
  "pattern": "\\b\\d{3}-\\d{2}-\\d{4}\\b",
  "isRegex": true,
  "action": "block",
  "enabled": true,
  "groupId": "grp_finance123"  // Only applies to Finance group
}

// HR team has more permissive policy (redact instead of block)
POST /api/admin/policies
{
  "name": "Redact SSNs (HR Team)",
  "pattern": "\\b\\d{3}-\\d{2}-\\d{4}\\b",
  "isRegex": true,
  "action": "redact",
  "enabled": true,
  "groupId": "grp_hr456"  // Only applies to HR group
}