⌘K
Documentation

Users Module - Groups

Overview

The Users Module is responsible for managing user accounts within the system.

Administrators can create, update, delete, activate, and manage user accounts through this module. It serves as the central location for user administration and access management.

The Groups page of the Users Module allows administrators to manage group permissions for the Users module.

By default, the page displays only groups that already have at least one permission assigned for the Users module. Groups are displayed in a paginated list.

When Edit Mode is enabled, all groups in the system are displayed, regardless of whether they currently have any permissions for the Users module. Administrators can then assign, update, or remove Users module permissions.

Prerequisites

Before managing Users module group permissions, ensure that:

  • You have administrator privileges.
  • Groups have already been created.

Viewing Groups

When the page is opened:

  • Groups are displayed in a paginated table.
  • Only groups with at least one permission in the Users module are shown.
  • Each row displays the group's current Users module permissions.

Edit Mode

Administrators can enable Edit Mode to modify group permissions.

When Edit Mode is enabled:

  • All groups in the system are displayed.
  • Users module permissions become editable.
  • Permission changes are stored locally until they are saved.
  • No changes are applied immediately.

Permission Assignment

Permissions can be assigned or removed directly from the group's row.

Selecting or deselecting a permission immediately updates the local state.

Changes remain pending until the administrator clicks Save.

Access Requirements

To access this page, the user must have the ACL permission for the Users module.

The ACL permission allows users to manage authorization settings for the Users module. Users without this permission cannot access this page unless they have administrator privileges.

Users without the required permission cannot view this page and will receive the following authorization error:

Access Denied

You don't have access to this resource.

Available Permissions

The following permissions are available within the Users module.

Permission Description
GET Allows the group to view the list of registered users. Groups without this permission cannot access the Users module or view user accounts.
CREATE Allows members of the group to create new user accounts.
UPDATE Allows members of the group to modify existing user accounts.
DELETE Allows members of the group to delete user accounts.
ACL (Access Control List) Allows the group to manage permissions for other groups within the Users module. Groups without this permission cannot modify group permissions in the Users module.

Saving Changes

After permission changes have been made:

  1. Review the pending changes.
  2. Click Save.
  3. Only modified permissions are sent to the server.
  4. Once the request succeeds, the new permissions become effective.

Reset Changes

Clicking Reset discards all unsaved modifications.

The permission list is restored to its last saved state.

No requests are sent to the server when Reset is used.

Validation

The system validates all permission changes before saving.

Permission updates are persisted only after a successful save operation.

Permission Dependencies

Having the ACL permission in the Users module alone is not sufficient to manage group permissions.

To manage groups within the Users module, the administrator must also have at least the GET permission in the Groups Module.

Without the Groups Module GET permission:

  • Groups cannot be retrieved.
  • User group permissions cannot be managed.
  • The operation results in an authorization error.

This dependency exists because group permission management requires access to group information provided by the Groups module.

Notes

  • Permission changes are stored locally until Save is clicked.
  • Reset discards all unsaved changes.
  • Only modified permissions are submitted to the server.
  • The group list is displayed using pagination for better performance.
ESC

Start typing to search across the documentation.