Learn how to create and manage new users in cPanel using the Manage Team feature.  This step-by-step guide covers everything from adding users via the cPanel UI to using cPanel UAPI for advanced user management.

Adding Team Users to Your WebHostingM cPanel

Ever felt the need for extra hands to manage your website?

WebHostingM's cPanel allows you to create additional user accounts, granting them specific permissions to collaborate on your projects.

This guide explores three methods for adding team users: the cPanel interface, the command line (CLI), and the WebHostingM API (UAPI).

Why Add Team Users?

There are many reasons to add team users:

  • Web Developers: Grant developers access to manage website files and databases.
  • Marketing Teams: Provide access to managing email accounts or marketing tools.
  • Support Staff: Offer limited access to support tasks.

The Power of Manage Teams:

cPanel's Manage Teams feature (available since cPanel & WHM version 112) simplifies user management. It allows you to:

  • Create and manage team users.
  • Assign roles and permissions.
  • Set password expiry dates.
  • Suspend or delete user accounts.
  • Track user activity through the Audit Log.

Understanding cPanel Users:

Before we dive into the tutorial, let's clarify some essential concepts:

  • Primary User: The main hosting admin account.
  • Team Owner: The primary cPanel account holder with complete access.
  • Team User: Virtual accounts created under the team owner's account with limited access.

Step 1: Accessing Manage Team:

  1. Log in to your cPanel account.
  2. Locate the Manage Team interface:
    • Upper-left corner of cPanel.
    • Use the Search function.
    • Scroll down to the Preferences section.

Step 2: Adding a New User via cPanel UI:

  1. Click on the Manage Team icon.
  2. Navigate to Create Team User.
  3. Enter user details: username, password, role, etc.
  4. Choose roles carefully: Administrator, Database, Email, Web.
  5. Set the user's password for consistent security.
  6. Click Create to finalize the process.

 

Here are the roles and their description:

Roles

Role Descriptions

 Administrator  Enables a team user to access high-level tools and modify files in the team owner's cPanel account. It includes all privileges connected to each of the other roles.
 Database  Enables a team user to access tools and modify files related to database management for the team owner's cPanel account, such as MySQL Manager.
 Email  Enables a team user to access tools and modify files related to email administration for the team owner's cPanel account, such as email routing and mailing lists.
 Web  Enables a team user to access tools and modify files related to website functionality, such as WordPress Toolkit and bandwidth.

 

Step 3: Adding a New User with cPanel UAPI:

  1. Determine required parameters: email, username, password, etc.
  2. Utilize optional parameters for customization.
  3. Execute the UAPI command to add a new team user.

Step 4: Managing Team Users:

  1. List all team users for easy reference.
  2. View user details including roles and contact email.
  3. Perform actions like Edit User, Suspend, or Delete as needed.
  4. Use UAPI commands for advanced management tasks.

Step 5: Additional User Management Tasks:

  • Suspend/Unsuspend a Team User.
  • Delete a Team User.
  • Send Password Reset.
  • Utilize the Audit Log for tracking user actions.

2. Adding Team Users via UAPI (Intermediate and Advanced users):

The UAPI (User Interface API) allows programmatic user management. This method is suitable for advanced users comfortable with command lines.

  1. Create a Team User:

    • Use uapi command with parameters like user, email1, password (or activation_email), roles, etc.
  2. List Team Users:

    • Use uapi with the Team module and list_team function.
  3. Suspend a Team User:

    • Use uapi with the Team module and suspend_team_user function.
  4. Reinstate a Team User:

    • Use uapi with the Team module and reinstate_team_user function.

    Here's an example of creating a user with an admin role and an expiration date:

    uapi --output=jsonpretty Team add_team_user user='Ava' email1='ava@webcomm.dev' password=H:4%Ju*=ha2n}nJD}yDh expire_date=1688181360 expire_reason="Terminated - Started a Flame War in the company Slack Channel"

3. Additional UAPI Commands (Advanced):

  • List Team Users:

    uapi --output=jsonpretty Team list_team

  • View Team Role Permissions:

    uapi --output=jsonpretty TeamRoles list_feature_descriptions

  • Suspend/Unsuspend User:

    uapi --output=jsonpretty Team suspend_team_user user='Ava' # Suspend

    uapi --output=jsonpretty Team reinstate_team_user user='Ava' # Unsuspend

  • Delete/Remove Roles:

    uapi --output=jsonpretty Team remove_team_user user='Ava' # Delete User

    uapi --output=jsonpretty Team remove_roles user='Ava' role='database' # Remove Database Role

  • Password Reset:

    uapi --output=jsonpretty Team password_reset_request user='Ava' # Send Reset Link

    uapi --output=jsonpretty Team set_password user='teamuser' password='securepassword' # Set New Password

Important Considerations:

  • Security: Always choose strong passwords and enforce regular password changes for team users.
  • Permissions: Assign roles that grant only the necessary level of access for each user.
  • Backups: Regularly back up your website and databases before making significant changes.

By following these steps and understanding the importance of user management, you can effectively collaborate with your team and keep your website operations running smoothly.

If you require further assistance or prefer not to use the UAPI, don't hesitate to contact WebHostingM's support team. We're happy to help you add team users to your cPanel account.

 

What role would you assign to a new team user?

  1. Administrator
  2. Database
  3. Email
  4. Web
Did this answer help? 0 People found this helpful (0 Votes)