Permisssions Model

Overview

The permisssions table defines the fine-grained permissions and access controls for screens, features, routes, or methods within a software system or application. Each record represents a single permission item that can be associated with roles, bundles, and applications.

Fields

Field	Type	Description	Required
id	string	A unique identifier for the permission	❌
bundle_id	any	The identifier of the associated bundle.	❌
device	any	Specifies which device or platform this permission applies to.	❌
override	any	Defines an override to default permission behavior, potentially modifying default rules for specific cases.	❌
ref_id	any	A reference ID that links this permission to another entity.	❌
name	string	The name of the permission.	❌
screen_name	string	A screen or UI name where the permission is applicable.	❌
license_role	any	The license role associated with the permission(siteAdmin/Admin/Editor/Viewer/Guest)	❌
permission_type	any	The type of permission granted or restricted.	❌
key	string	A unique key associated with the permission.	❌
application_id	string	The identifier of the application linked to the permission. This links permissions to specific apps in multi-application environments.	❌
type	any	The type or category of the permission.	❌
feature	any	Identifies the feature or area of the application the permission applies to.	❌
description	string	A detailed description of the permission.	❌
applicationitem_id	string	Refers to a specific application item (module, component) related to the permission.	❌
predefined_bundle	string	Indicates if the permission is part of a predefined bundle	❌
routes	array	Defines the routes or endpoints associated with this permission.	❌
method	string	The HTTP method (e.g., GET, POST) that the permission applies to for a particular route.	❌
predefined_bundle_id	string	The identifier of the predefined bundle containing this permission.	❌
package_id	string	The identifier of the package to which this permission belongs.	❌
isGeneric	boolean	Flag indicating whether the permission is generic across all users (1) or specific to a subset (0).	❌
controlled	any	Defines controlled access restrictions for this permission	❌
notAllowed	any	Defines restrictions or exceptions where this permission is not allowed.	❌
created_at	date	The timestamp when the permission was created.	❌
modified_at	date	The timestamp when the permission was last updated.	❌
isSystemGenerated	boolean	Flag indicating if the permission was system-generated (1) or user-defined (0).	❌
bundle_type	string	The type of bundle associated with this permission.	❌
orgId	string	The identifier of the organization related to this permission.	❌
businessObject	string	The business object associated with this permission.	❌
active	any	Active flag indicating whether the permission is currently enabled .	❌
roleIds	any	A list of role IDs associated with this permission. Could be used to track which roles or users have this permission.	❌

Sample JSON

{
  "id": "example_value",
  "bundle_id": "example_value",
  "device": "example_value",
  "override": "example_value",
  "ref_id": "example_value",
  "name": "example_value",
  "screen_name": "example_value",
  "license_role": "example_value",
  "permission_type": "example_value",
  "key": "example_value",
  "application_id": "example_value",
  "type": "example_value",
  "feature": "example_value",
  "description": "example_value",
  "applicationitem_id": "example_value",
  "predefined_bundle": "example_value",
  "routes": "example_value",
  "method": "example_value",
  "predefined_bundle_id": "example_value",
  "package_id": "example_value",
  "isGeneric": "example_value",
  "controlled": "example_value",
  "notAllowed": "example_value",
  "created_at": "example_value",
  "modified_at": "example_value",
  "isSystemGenerated": "example_value",
  "bundle_type": "example_value",
  "orgId": "example_value",
  "businessObject": "example_value",
  "active": "example_value",
  "roleIds": "example_value"
}