Org Model

Overview

The org table stores information about organizations in the system, including basic details like the organization's name, description, and status. It is designed to manage different organizations, track their activities, and hold information such as logos, sites, and required keys for system access.

Fields

Field	Type	Description	Required
id	string	Unique identifier for the organization. Used for joining with other tables like users, packages, etc.	❌
externalOrgId	string	External reference ID for the organization. Helps sync or link internal org data with external systems.	❌
orgname	string	The name of the organization. Display name for the org in dashboards, filters, access controls.	✅
tenantlogo	string	URL or path to the organization's logo. Used for UI branding (e.g., white-labeling per org).	❌
description	string	Brief description of the organization. Metadata to describe the org’s purpose or nature.	❌
isActive	boolean	Indicates if the organization is currently active (1 = yes, 0 = no). Controls whether this org can access the platform.	❌
created_at	date	Timestamp when the organization record was created. Used for audits, reports, or filtering recently added orgs.	❌
modified_at	date	Timestamp when the organization record was last modified. Track changes or updates to the org's profile.	❌
sites_id	string	Reference to the site(s) associated with this org. Links orgs to physical or logical site locations (for multi-site setups).	❌
requiredKeys	array	List of required keys or configurations for the organization.Stores custom validation rules, keys, or fields that must be set for this org.	❌
isSystemGenerated	boolean	Boolean flag indicating if the organization record was system-generated. Helps distinguish manually created orgs vs. ones created via automation or migration scripts.	❌

Relationships

• Hasmany Unknown

Sample JSON

{
  "id": "example_value",
  "externalOrgId": "example_value",
  "orgname": "example_value",
  "tenantlogo": "example_value",
  "description": "example_value",
  "isActive": "example_value",
  "created_at": "example_value",
  "modified_at": "example_value",
  "sites_id": "example_value",
  "requiredKeys": "example_value",
  "isSystemGenerated": "example_value"
}