OrgGroup Model

Overview

The orggroup table is designed to manage the grouping of users, their roles, and the associated organizational information. It tracks user-related attributes such as account status, authentication settings, and site access. Additionally, it maps the user to specific organizational units, roles, and packages within the system.

Fields

Field	Type	Description	Required
id	string	Unique identifier for the organization group. Acts as the primary key for referencing this user-role-org mapping.	❌
hierarchyItemId	string	Identifier linking the group to a hierarchy structure. Used to define where the user belongs in an org chart or hierarchy tree.	❌
externalUserId	string	External reference ID for the user associated with the group.Helps link internal users with accounts in third-party systems.	❌
application_id	string	Identifier linking the group to an application. Enables multi-application support — same user can belong to different apps.	❌
AccountStatus	boolean	Indicates if the account is active (1) or inactive (0)..Used to temporarily disable access without deleting the record.	❌
created_at	date	Timestamp when the organization group record was created. For tracking history or auditing user-role changes.	❌
modified_at	date	Timestamp when the organization group record was last modified. For tracking updates, especially useful in syncing systems.	❌
lineItemId	any	Identifier for the associated line item. May link to a granular permission or feature flag assigned individually.	❌
user_id	string	Identifier linking the group to a specific user. Main link to the user profile or account in the system.	✅
packageId	any	Identifier linking the group to a package. Grants access to a bundle of features or capabilities.	❌
package_line_id	any	Identifier linking to a specific package line item. Allows for fine-grained access control inside a broader package.	❌
sites_id	string	Identifier linking the group to a site. Supports multi-site architecture; enables site-based access/permissions.	✅
org_id	string	Identifier linking the group to an organization. Critical for scoping access to specific organizations in multi-tenant systems.	✅
roles_id	string	Identifier linking the group to a specific role. Determines the user's privileges (admin, editor, viewer, etc.).	❌
defaultLoginType	string	Default login method/type for users in this group. Helps customize the authentication flow per user or org policy.	❌
userAuthentication	string	Defines authentication settings for the user in the group. Stores how the user authenticates — useful for hybrid auth systems.	❌
schedulerAllowed	boolean	Boolean flag indicating if scheduling is allowed for the group. Enables or disables access to scheduler-specific modules.	❌
externalAPIAccess	any	Boolean flag indicating if external API access is allowed. Defines custom API access rules or scopes for the user.	❌
isActive	boolean	Boolean flag indicating if the organization group is active. Often used instead of AccountStatus; controls effective access.	❌
apps	array	apps field	❌

Sample JSON

{
  "id": "example_value",
  "hierarchyItemId": "example_value",
  "externalUserId": "example_value",
  "application_id": "example_value",
  "AccountStatus": "example_value",
  "created_at": "example_value",
  "modified_at": "example_value",
  "lineItemId": "example_value",
  "user_id": "example_value",
  "packageId": "example_value",
  "package_line_id": "example_value",
  "sites_id": "example_value",
  "org_id": "example_value",
  "roles_id": "example_value",
  "defaultLoginType": "example_value",
  "userAuthentication": "example_value",
  "schedulerAllowed": "example_value",
  "externalAPIAccess": "example_value",
  "isActive": "example_value",
  "apps": "example_value"
}