Personal tools
Namespaces

Variants
Actions

Access Control Tool

From ModulesGarden Wiki
Jump to: navigation, search

Contents

About Access Control Tool

The Access Control tool lets you define which sections and features of the module can be accessed by specific administrators.
It also maintains detailed logs of admin activities, providing a clear record for accountability.

With this tool, you can easily manage permissions and ensure that access is tailored to your team’s needs.

  • Available in Addon Modules:
✔ Hosting Renewals For WHMCS
✔ Password Manager For WHMCS
✔ Recurring Contract Billing For WHMCS
✔ Report Generator For WHMCS
✔ WordPress Manager For WHMCS

Management

The Access Control Tool allows easy management of permissions that will restrict your personnel to view resources and perform specified module actions.

It can be located in one of two places, depending on the layout of the addon module menu. It may either appear directly in the main menu or be grouped under the "Other" section alongside additional features.
This setup is illustrated below using the WordPress Manager For WHMCS module as an example.
Note: This arrangement is commonly used when the addon has a significant number of menu entries.

'Rules', 'Resources', and 'Logs' are the three sections that build the Access Control tool. Please refer to the below sections to learn all the details.

Rules

Start with creating a new rule, click on the 'Create Rule' button and a dedicated form will appear. Below you will find a description of every field required in the form.
WMAC 1.png
Fill out the following fields to create resources access rule:
  • Rule Name - pick a name for your rule.
  • Grant Full Access - enable to grant full access to all sections of the module to the specified personnel. Disable to specify in two additional fields below, to which resources access will be granted, and to which it will be denied.
  • Allow Access To - designate the resources that the specified personnel will have access to.
  • Restrict Access To - specify the resources that the specified personnel will not have access to.
  • Administrators - specify which singular administrators will be subject to the new rule. If the specific administrator is already included in the group you have picked, you do not need to add them separately.
    Note: All restrictions for specific administrators are summed with the restrictions on their role groups, across all rules.
  • Administrator Roles - specify which administrator role groups will be subject to the new rule.

Important: When picking specific sections, keep in mind that allowing a parent section will also allow all of its children.
For example by allowing 'Logs' you allow 'Logs → Export,' 'Logs → Delete' etc.'
If you would like to give access to everything about logs, but the ability to delete them, you can pick 'Logs' in 'Allow Access To' and then 'Logs → Delete' in 'Restrict Access To.'
Restrict takes precedence over Allow, so if a specific section is included in both, it will be restricted.

WMAC 2.png
To edit or delete existing rules, use the icons to the right.
WMAC 3.png

Resources

Use the toggles in the 'Resources' section to specify which of them should be subject to logging.

Every time an administrator requests a toggled resource, it will be recorded in the 'Logs' section.

WMAC 4.png

Access Control Logs

The logs entries include:
  • Log ID
  • Name of the administrator
  • Requested resource
  • Applied Resource
  • Rule Name
  • Date

Use the trash bin icons to delete specific logs, or utilize the mass action function to delete multiple logs at once.

WMAC 5.png
Navigation
WHMCS Modules
WHMCS Widgets
Tools And Applications
Translations
cPanel Modules
General
FAQ
Community