Represents a security group in Lime CRM.

Groups are used to organize users and control their access permissions. Users inherit permissions from all groups they belong to. Groups typically represent departments, roles, or permission levels within the organization.

Example

// Check if user belongs to specific groups
const user = appRepo.getCurrentUser();
const adminGroup = user.groups.find(g => g.name === 'Administrators');
if (adminGroup) {
console.log(`User is admin (Group ID: ${adminGroup.id})`);
console.log(`Description: ${adminGroup.description}`);
}

Hierarchy

  • UserGroup

Properties

Properties

description: string

Human-readable description of the group's purpose.

Provides additional context about what the group represents and what permissions it typically grants.

id: number

The numeric identifier for the group.

Used internally for group references in the database.

name: string

The unique name identifier for the group.

Group names are used throughout the system for permission checks and access control.