User Group Properties

This table defines the structure of the user group entity, including all properties and their descriptions.

🔹 Core Properties

Property	Type	Required	Description	Example
name	string	Yes	Name of the user group. Must be at least 1 character long.	"Sales Team"
description	string	No	Detailed description of the user group and its purpose.	"Sales team members with access to product management"
externalId	string	No	External identifier for integration with other systems.	"SALES_TEAM_01"
organizationId	string	Yes	UUID of the organization this group belongs to.	"123e4567-e89b-12d3-a456-426614174000"
extraFields	object	No	Additional custom fields for the user group. Can contain any valid JSON data.	See example below

---

🧩 Example Entry

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Sales Team",
  "description": "Sales team members with access to product management",
  "externalId": "SALES_TEAM_01",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "extraFields": {
    "department": "Sales",
    "location": "New York",
    "allowedFeatures": [
      "product_management",
      "sales_reports"
    ]
  },
  "createdAt": "2025-05-22T10:30:00Z",
  "updatedAt": "2025-05-22T10:30:00Z"
}

---

🔍 Interpretation

• The user group belongs to a specific organization identified by organizationId
• It has a unique name "Sales Team" and a descriptive purpose
• The externalId can be used to map this group to external systems
• Custom data is stored in extraFields, including:
  • Department assignment
  • Physical location
  • List of allowed features
• System tracks creation and last update timestamps in UTC

---

✅ Use Cases

• 👥 Team Organization: Group users by department, role, or function
• 🔐 Access Control: Manage permissions and feature access for different teams
• 🌐 Multi-System Integration: Use externalId for mapping to other platforms
• 📊 Resource Management: Track team locations and department assignments
• 🔄 Workflow Automation: Base automated processes on group properties

---

📘 Notes

• Naming: Group names must be unique within an organization
• Timestamps: All dates are in ISO 8601 format with UTC timezone
• Extensibility: The extraFields object supports any valid JSON structure
• Integration: Use externalId when synchronizing with external systems
• Updates: The updatedAt field automatically reflects the latest change
• Organization: Groups are always scoped to a specific organization

---