Administrators and Permissions - Revision history

SarahK at 18:13, 18 April 2022

2022-04-18T18:13:19Z

SarahK at 17:46, 17 January 2022

2022-01-17T17:46:29Z

SarahK at 22:14, 12 January 2022

2022-01-12T22:14:48Z

Lawrence: /* Debugging provisioning modules */

2021-04-28T20:08:08Z

‎Debugging provisioning modules

Lawrence: /* Limiting access to a specific installed addon */

2021-04-28T20:07:16Z

‎Limiting access to a specific installed addon

Lawrence: /* Limiting access to a specific installed addon */

2021-04-28T20:06:37Z

‎Limiting access to a specific installed addon

Lawrence: /* Common Role Configurations */

2021-04-28T20:05:39Z

‎Common Role Configurations

Lawrence: /* Limiting access to a specific installed addon */

2021-04-28T19:55:30Z

‎Limiting access to a specific installed addon

Lawrence: /* Limiting access to a specific addon */

2021-04-28T19:54:41Z

‎Limiting access to a specific addon

Lawrence: /* Providing access to a developer to debug an issue with an addon */

2021-04-28T19:52:49Z

‎Providing access to a developer to debug an issue with an addon

@@ Line 1: / Line 1: @@
-WHMCS allows you to create admins who can access and use the Admin Area. These users are separate from the clients that access the Client Area. You can create individual accounts for each admin and use detailed controls to set what they're able to view and do for each area of functionality.
+WHMCS allows you to create admins who can access and use the [[Admin Area]]. These users are separate from the clients that access the Client Area. You can create individual accounts for each admin and use detailed controls to set what they're able to view and do for each area of functionality.
 ==Administrator Users==
-You can create and manage admins, including assigning administrator roles and support departments, at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Administrator Users'''.
+You can create and manage admins, including assigning administrator roles and support departments, at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Administrator Users]]''' or, prior to WHMCS 8.0, '''Setup > Staff Management > Administrator Users'''.
 For more information, see [[Administrator Users]].
@@ Line 9: / Line 9: @@
 ==Managing Administrator Roles==
-The administrator roles allow you to fine tune exactly what each of your admin users can do within your WHMCS administration area. You can set up administrator roles under '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Administrator Roles'''.
+The administrator roles allow you to fine tune exactly what each of your admin users can do within your WHMCS administration area. You can set up administrator roles under '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Administrator Roles]]''' or, prior to WHMCS 8.0, '''Setup > Staff Management > Administrator Roles'''.
 For more information, see [[Administrator Roles]].

@@ Line 1: / Line 1: @@
-WHMCS offers several interfaces to grant you control over access to the WHMCS Admin Area. You can create new staff members on the '''Administrator Users''' page, set their permissions on the '''Administrator Roles''' page, and enhance login security by configuring '''Two Factor Authentication'''.
+WHMCS allows you to create admins who can access and use the Admin Area. These users are separate from the clients that access the Client Area. You can create individual accounts for each admin and use detailed controls to set what they're able to view and do for each area of functionality.
-==Managing Admins==
+==Administrator Users==
-To set up additional admins, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Administrator Users'''. From here, you can view and edit existing operators as well as adding new ones. When editing an operator you can change all the details of the operator, including resetting their password. It also allows you to see any notes they have made for themselves.
+You can create and manage admins, including assigning administrator roles and support departments, at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Administrator Users'''.
-Admin usernames should use the following format:
+For more information, see [[Administrator Users]].
 ==Managing Administrator Roles==
-The administrator roles allow you to fine tune exactly what each of your admin users can do within your WHMCS administration area.  You can set up as many different role groups as you want and then assign your admins to them as you need to.  WHMCS comes with three default roles: Full, Sales, and Support Only.
+The administrator roles allow you to fine tune exactly what each of your admin users can do within your WHMCS administration area. You can set up administrator roles under '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Administrator Roles'''.
-You can set up administrator roles under '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Administrator Roles]]'''.
+For more information, see [[Administrator Roles]].

@@ Line 1: / Line 1: @@
-The Staff Management menu contains three sections: '''Administrator Users''', '''Administrator Roles''', and '''Two Factor Authentication'''. These allow for control over access to the WHMCS admin area. You can create new staff members on the '''Administrator Users''' page, set their permissions on the '''Administrator Roles''' page, and enhance login security by configuring '''Two Factor Authentication'''.
+WHMCS offers several interfaces to grant you control over access to the WHMCS Admin Area. You can create new staff members on the '''Administrator Users''' page, set their permissions on the '''Administrator Roles''' page, and enhance login security by configuring '''Two Factor Authentication'''.
-==Managing Administrators==
+==Managing Admins==
-To set up additional admins, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > Manage Admins > Administrator Users'''. From here, you can view and edit existing operators as well as adding new ones. When editing an operator you can change all the details of the operator, including resetting their password. It also allows you to see any notes they have made for themselves.
+To set up additional admins, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Administrator Users'''. From here, you can view and edit existing operators as well as adding new ones. When editing an operator you can change all the details of the operator, including resetting their password. It also allows you to see any notes they have made for themselves.
 Admin usernames should use the following format:
@@ Line 24: / Line 24: @@
 Please note that if the admin is assigned to a role that has "Access All Tickets Directly" enabled, they will be able to access tickets that are not in their assigned department(s) if they have a direct link.
 </div>
 ===Assign an Admin to a Role===
@@ Line 63: / Line 29: @@
 To assign an admin to a role:
-#Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Staff Management > Administrator Users'''.
+#Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings >  Administrator Users'''.
 #Click the edit icon next to the admin you want to change.
 #In the '''Role Group''' menu, choose the role you want to assign the admin to.
 #Click save. The change will take effect immediately.
-==Common Role Configurations==
+==Managing Administrator Roles==
-===Limiting access to a specific installed addon===
+The administrator roles allow you to fine tune exactly what each of your admin users can do within your WHMCS administration area.  You can set up as many different role groups as you want and then assign your admins to them as you need to.  WHMCS comes with three default roles: Full, Sales, and Support Only.
-===Debugging provisioning modules===
+===Role Permissions===
-==Managing Two Factor Authentication==
+One of the most important features of the admin area is being able to control what particular admins are able to access and manage. For example, you may want to give support operators less access to make changes than the business owner. WHMCS uses administrator roles to implement this.
-You can apply Two-Factor Authentication to staff, clients, or both. Instructions for configuring Two-Factor Authentication are on the [[Security_Modules#Configuration|Security Modules page]].
+You can set up administrator roles under '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Administrator Roles]]'''.

@@ Line 76: / Line 76: @@
 ===Debugging provisioning modules===
-For debugging provisioning modules, it may be helpful to enable the "Configure Servers", "View Clients Products/Services", "View Module Debug Log", and "Perform Module Command Operations" permissions so that the developer is able to ensure the underlying module is correctly configured, test with a test service and obtain any module log data (if their module supports it). Further permissions, such as the ability to edit services with "Edit Clients Products/Services", are generally not recommended and should only be considered on a case-by-case basis.
+For debugging provisioning modules, it may be helpful to enable the '''Configure Servers''', '''View Clients Products/Services''', '''View Module Debug Log''', and '''Perform Module Command Operations''' permissions so that the developer is able to ensure the underlying module is correctly configured, test with a test service and obtain any module log data (if their module supports it). Further permissions, such as the ability to edit services with '''Edit Clients Products/Services''', are generally not recommended and should only be considered on a case-by-case basis.
 ==Managing Two Factor Authentication==

@@ Line 71: / Line 71: @@
 ===Limiting access to a specific installed addon===
-This is commonly required for allowing third party developers limited access to the WHMCS admin area in order to debug an issue with an installed addon module. For addon modules, the ''Addon Modules'' permission will need to be enabled and then the ''Access Control'' setting on the applicable addon will need to be edited under '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Addon Modules''' to give their admin user access to the addon under the Addons menu (if applicable).
+This is commonly required for allowing third party developers limited access to the WHMCS admin area in order to debug an issue with an installed addon module. For addon modules, the '''Addon Modules''' permission will need to be enabled and then the '''Access Control''' setting on the applicable addon will need to be edited under '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Addon Modules''' to give their admin user access to the addon under the Addons menu (if applicable).
-Depending on how the addon operates, it may be necessary to enable additional permissions as well (at discretion). For example: if an addon adds a "Support PIN" number on the client summary page, enabling the ''View Clients Summary'' permission may be necessary for the developer to be able to access a test client and verify it is working as expected.
+Depending on how the addon operates, it may be necessary to enable additional permissions as well (at discretion). For example: if an addon adds a "Support PIN" number on the client summary page, enabling the '''View Clients Summary''' permission may be necessary for the developer to be able to access a test client and verify it is working as expected.
 ===Debugging provisioning modules===

← Older revision		Revision as of 20:05, 28 April 2021
Line 74:		Line 74:

	Depending on how the addon operates, it may be necessary to enable additional permissions as well (at discretion). For example: if an addon adds a "Support PIN" number on the client summary page, enabling the "View Clients Summary" permission may be necessary for the developer to be able to access a test client and verify it is working as expected.		Depending on how the addon operates, it may be necessary to enable additional permissions as well (at discretion). For example: if an addon adds a "Support PIN" number on the client summary page, enabling the "View Clients Summary" permission may be necessary for the developer to be able to access a test client and verify it is working as expected.
		+
		+	===Debugging provisioning modules===
		+	For debugging provisioning modules, it may be helpful to enable the "Configure Servers", "View Clients Products/Services", "View Module Debug Log", and "Perform Module Command Operations" permissions so that the developer is able to ensure the underlying module is correctly configured, test with a test service and obtain any module log data (if their module supports it). Further permissions, such as the ability to edit services with "Edit Clients Products/Services", are generally not recommended and should only be considered on a case-by-case basis.

	==Managing Two Factor Authentication==		==Managing Two Factor Authentication==

@@ Line 71: / Line 71: @@
 ===Limiting access to a specific installed addon===
-This is commonly required for allowing third party developers limited access to the WHMCS admin area in order to debug an issue with an installed addon module. For addon modules, the "Addon Modules" permission will need to be enabled and then the "Access Control" setting on the applicable addon will need to be edited under ''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Addon Modules''' to give their admin user access to the addon under the Addons menu (if applicable).
+This is commonly required for allowing third party developers limited access to the WHMCS admin area in order to debug an issue with an installed addon module. For addon modules, the "Addon Modules" permission will need to be enabled and then the "Access Control" setting on the applicable addon will need to be edited under '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Addon Modules''' to give their admin user access to the addon under the Addons menu (if applicable).
 Depending on how the addon operates, it may be necessary to enable additional permissions as well (at discretion). For example: if an addon adds a "Support PIN" number on the client summary page, enabling the "View Clients Summary" permission may be necessary for the developer to be able to access a test client and verify it is working as expected.

@@ Line 70: / Line 70: @@
 ==Common Role Configurations==
-===Providing access to a developer to debug an issue with an addon===
+===Limiting access to a specific addon===
 ==Managing Two Factor Authentication==