Apps Model

Overview

The apps table is designed to store information about applications registered within the system. It contains details about the app's domain, authentication credentials, associated users, business applications, and organizational relationships.

Fields

Field	Type	Description	Required
id	string	Primary Key – Unique identifier for each app (typically a UUID).	❌
appName	string	The Name of the Application	✅
appDomain	string	The domain or URL associated with the application	✅
appDescription	any	A detailed description of the application, including its purpose, features, or capabilities.	❌
clientId	string	The client identifier used for authentication (OAuth or API-based apps).	❌
clientSecret	string	A secret key used in conjunction with the clientId for authentication in OAuth2 flows or API calls.	❌
user	any	Represents the users associated with the application. This may include a list of user roles or permissions in a serialized format.	✅
businessApplication	any	Describes the business context or application under which the app operates. This could relate to business processes, modules, or departments.	✅
scopes	object	Defines the scopes or permissions assigned to this application (e.g., read, write, admin).	❌
status	boolean	Boolean flag indicating whether the app is active (1) or inactive (0).	❌
created_at	date	Timestamp of when the app was created.	❌
modified_at	date	Timestamp of when the app was last modified.	❌
sites_id	string	The ID of the site or environment where the application is deployed or active.	✅
org_id	string	The ID of the organization to which the application belongs.	✅
application_id	string	Reference to an existing application in the applications table.	❌

Sample JSON

{
  "id": "example_value",
  "appName": "example_value",
  "appDomain": "example_value",
  "appDescription": "example_value",
  "clientId": "example_value",
  "clientSecret": "example_value",
  "user": "example_value",
  "businessApplication": "example_value",
  "scopes": "example_value",
  "status": "example_value",
  "created_at": "example_value",
  "modified_at": "example_value",
  "sites_id": "example_value",
  "org_id": "example_value",
  "application_id": "example_value"
}