UserGroups Model

Overview

This table stores user groups within an application, linking them to specific organizations, sites, and applications. Each user group has a name, description, default role, and members associated with it.

Fields

Field	Type	Description	Required
id	string	A unique identifier for the user group.This is the primary key, ensuring every group can be referenced uniquely.	❌
orgId	string	The identifier of the organization to which the user group belongs. Essential in multi-tenant systems where each organization has its own set of groups.	✅
application_id	string	The identifier of the application associated with the user group. Supports app-specific roles and permissions.	✅
siteId	string	The identifier of the site related to the user group.	✅
name	string	The name of the user group.Used to identify the group in UI and APIs.	❌
description	string	A textual description of the group’s purpose or members.	❌
defaultRole	any	The default role assigned to members of the group	❌
members	array	A list of users who are part of the group	❌
created_at	date	The timestamp when the user group was created.	❌
modified_at	date	The timestamp when the user group was last updated.	❌
tags	array	Additional labels or tags associated with the user group, typically stored in text format. Used for labeling or categorizing groups. Common in systems with many groups, helping to search/filter them.	❌

Sample JSON

{
  "id": "example_value",
  "orgId": "example_value",
  "application_id": "example_value",
  "siteId": "example_value",
  "name": "example_value",
  "description": "example_value",
  "defaultRole": "example_value",
  "members": "example_value",
  "created_at": "example_value",
  "modified_at": "example_value",
  "tags": "example_value"
}