cPanel/Team
cPanel module

Team

17 functions, invoked through the cpanel_uapi tool.

scope cpanel:uapi
Call any function with cpanel_uapi(service_id, module="Team", function, params). Live availability depends on the cPanel features JetHost has enabled on your account — call list_cpanel_operations to see what is active.

add_roles GET#

Add roles to a team user

This function adds roles to a team user.

Note:

This action may result in team users gaining access to team owner level privileges.

rolestringRequired
The role or roles to add to the team user. Current roles include admin, database, email, web.
userstringRequired
The username of the team user.

Response — normalized as { ok, data, errors[], warnings[] }; data contains:

Payload varies by call.

add_team_user GET#

Add a team user

This function creates and adds a new team user.

Note:

This action may result in team users gaining access to team owner level privileges.

email1stringRequired
The contact email for the new team user.
userstringRequired
The username of the team user. Follows cPanel standards.
activation_emailintegerOptional
Send an email to the team user that allows them to set their own password. 1 - Enabled. Note: You must pass either the password or activation_email parameter.
email2stringOptional
The secondary email for the new team user.
expire_datemixedOptional
The epoch time on which the team user account expires, or the offset from the current time, in days. Integers are treated as Unix Epoch Time unless followed by 'days'.
expire_reasonstringOptional
The reason for expiration.
notesstringOptional
Notes about the new team user. This field should not contain private information. Maximum of 100 characters.
passwordstringOptional
The password to set for the new team user. Note: * You must pass either the password or activation_email parameter.
rolesstringOptional
A comma-separated list of roles assigned to the new team user. Current roles include admin, database, email, web.
services.email.enabledintegerOptional
Whether to create an email subaccount for the team user. A subaccount is always created for a team user, but it does not have any associated service subaccounts by default. 1 - Create an email subaccount. 0 - Do Not create an email subaccount.
services.email.quotastringOptional
The maximum amount of disk space, in megabytes (MB), allocated to the team user's email account. * 0 or unlimited - The subaccount has unlimited disk space. This value defaults to the defined system value. Note: This value cannot be larger than the system's maximum email quota.
services.ftp.enabledintegerOptional
Whether to create an FTP subaccount for the team user. A subaccount is always created for a team user, but it does not have any associated service subaccounts by default. 1 - Create an FTP subaccount. 0 - Do Not create an FTP subaccount.
services.ftp.homedirstringOptional
The team user's FTP home directory, relative to the cPanel account's home directory. Note: This parameter is required if you enabled the services.ftp.homedir parameter. The directory must exist.
services.webdisk.enabledintegerOptional
Whether to create a Web Disk subaccount for the team user. A subaccount is always created for a team user, but it does not have any associated service subaccounts by default. 1 - Create a Web Disk subaccount. 0 - Do Not create a Web Disk subaccount.
services.webdisk.enabledigestintegerOptional
Whether to enable the Web Disk Digest Authentication. 1 - Enabled. 0 - Disabled. Note: Only enable Digest Authentication for clients that require additional compatibility support on certain versions of Windows® operating systems. This compatibility support is only required on servers that use a self-signed certificate for the cpsrvd and cpdavd daemons. We recommend that you do not use Digest Authentication.
services.webdisk.homedirstringOptional
The team user's Web Disk home directory, relative to the cPanel account's home directory. Note: This parameter is required if you enable the services.webdisk.enabled parameter.
services.webdisk.permsstringOptional
The team user's file permissions for its Web Disk home directory. ro - Read-only permissions. rw - Read and write permissions. Note: The services.webdisk.homedir parameter determines the team user's Web Disk home directory.
services.webdisk.privateintegerOptional
Whether to set the directory's permissions to public or private. 1 - Private (0700). 0 - Public (0755).

Response — normalized as { ok, data, errors[], warnings[] }; data contains:

The unix timestamp that represents when the team user expires.

cancel_expire GET#

Stop a team user from expiring

This function stops a team user from expiring.

userstringRequired
The username of the team user.

Response — normalized as { ok, data, errors[], warnings[] }; data contains:

Payload varies by call.

edit_team_user GET#

Edit a team user

This function modifies a team user.

userstringRequired
The username of the team user.
add_rolestringOptional
The role or roles to add to the team user.
email1stringOptional
The primary contact email address to set for the team user.
email2stringOptional
The secondary contact email address to set for the team user.
expire_reasonstringOptional
The reason for expiration.
notesstringOptional
Notes about the new team user. This field should not contain private information.
passwordstringOptional
The password to set for the team user.
remove_rolestringOptional
The role or roles to remove from the team user.
services.email.enabledintegerOptional
Whether to create or remove an email subaccount for the team user. A subaccount is always created for a team user, but it does not have any associated service subaccounts by default. 1 - Create and associate an email subaccount. 0 - Remove any associated email subaccounts.
services.email.quotastringOptional
The maximum amount of disk space, in megabytes (MB), allocated to the team user's email account. * 0 or unlimited - The subaccount has unlimited disk space. This value defaults to the defined system value. Note: This value cannot be larger than the system's maximum email quota.
services.ftp.enabledintegerOptional
Whether to create or remove an FTP subaccount for the team user. A subaccount is always created for a team user, but it does not have any associated service subaccounts by default. 1 - Create and associate an FTP subaccount. 0 - Remove any associated FTP subaccounts.
services.ftp.homedirstringOptional
The team user's FTP home directory, relative to the cPanel account's home directory. Note: This parameter is required if you enabled the services.ftp.homedir parameter. The directory must exist.
services.webdisk.enabledintegerOptional
Whether to create or remove a Web Disk subaccount for the team user. A subaccount is always created for a team user, but it does not have any associated service subaccounts by default. 1 - Create and associate a Web Disk subaccount. 0 - Remove any associated Web Disk subaccounts.
services.webdisk.enabledigestintegerOptional
Whether to enable the Web Disk Digest Authentication. 1 - Enabled. 0 - Disabled. Note: Only enable Digest Authentication for clients that require additional compatibility support on certain versions of Windows® operating systems. This compatibility support is only required on servers that use a self-signed certificate for the cpsrvd and cpdavd daemons. We recommend that you do not use Digest Authentication.
services.webdisk.homedirstringOptional
The team user's Web Disk home directory, relative to the cPanel account's home directory. Note: This parameter is required if you enable the services.webdisk.enabled parameter.
services.webdisk.permsstringOptional
The team user's file permissions for its Web Disk home directory. ro - Read-only permissions. rw - Read and write permissions. Note: The services.webdisk.homedir parameter determines the team user's Web Disk home directory.
services.webdisk.privateintegerOptional
Whether to set the directory's permissions to public or private. 1 - Private (0700). 0 - Public (0755).
set_expiremixedOptional
The epoch time the team user account expires on or the offset in days.
set_rolestringOptional
The role or roles to set for the team user.

Response — normalized as { ok, data, errors[], warnings[] }; data contains:

Payload varies by call.

get_team_users_with_roles_count GET#

Get number of team users with roles

This function returns the current and maximum number of team users with roles.

No parameters.

Response — normalized as { ok, data, errors[], warnings[] }; data contains:

maxinteger
Maximum number of team users with roles. Note: This value is stored in the package.
usedinteger
The current number of team users with roles.

list_team GET#

List Team Users

This function lists the team users connected to a cPanel account. This list is given in an array by default, but can be given in a hash.

formatstringOptional
The format in which the team data is listed.

Response — normalized as { ok, data, errors[], warnings[] }; data contains:

Payload varies by call.

password_reset_request GET#

Sends a password reset request link to team user.

This function enables a team user to reset the password by sending a password reset request link.

userstringRequired
The username of the team user.

Response — normalized as { ok, data, errors[], warnings[] }; data contains:

Payload varies by call.

reinstate_team_user GET#

Reinstate a team user

This function reinstates a team user by removing any suspended or expired statuses. The reason field is also cleared.

userstringRequired
The username of the team user.

Response — normalized as { ok, data, errors[], warnings[] }; data contains:

Payload varies by call.

remove_roles GET#

Remove roles from a team user

This function removes roles from a team user.

rolestringRequired
The role or roles to remove from the team user.
userstringRequired
The username of the team user.

Response — normalized as { ok, data, errors[], warnings[] }; data contains:

Payload varies by call.

remove_team_user GET#

Remove a team user

This function removes a team user.

userstringRequired
The username of the team user.

Response — normalized as { ok, data, errors[], warnings[] }; data contains:

Payload varies by call.

set_contact_email GET#

Set a contact email address for a team user

This function sets or changes primary and secondary email addresses.

userstringRequired
The username of the team user.
email1stringOptional
The primary contact email address to set for the team user.
email2stringOptional
The secondary contact email address to set for the team user.

Response — normalized as { ok, data, errors[], warnings[] }; data contains:

Payload varies by call.

set_expire GET#

Set a team user to expire

This function expires a team user after a specified amount of time.

If the team user already has an expire date set, it's replaced with a new date and reason.

datemixedRequired
The epoch time on which the team user account expires, or the offset from the current time, in days. Integers are treated as Unix Epoch Time unless followed by 'days'.
userstringRequired
The username of the team user.
reasonstringOptional
The reason for expiration.

Response — normalized as { ok, data, errors[], warnings[] }; data contains:

The unix timestamp that represents when the team user expires.

set_locale GET#

Set locale for a team user

This function sets locale for a team user.

localestringRequired
The new locale for the team user.
userstringRequired
The username of the team user.

Response — normalized as { ok, data, errors[], warnings[] }; data contains:

Payload varies by call.

set_notes GET#

Set notes for a team user

This function replaces the current notes field with new text.

notesstringRequired
The content of the notes field.
userstringRequired
The username of the team user.

Response — normalized as { ok, data, errors[], warnings[] }; data contains:

Payload varies by call.

set_password GET#

Set password for a team user

This function replaces the current password with a new one.

passwordstringRequired
The password to set for the team user.
userstringRequired
The username of the team user.

Response — normalized as { ok, data, errors[], warnings[] }; data contains:

Payload varies by call.

set_roles GET#

Set roles for a team user

This function sets roles for a team user.

Note:

This action may result in team users gaining access to team owner level privileges.

userstringRequired
The username of the team user.
rolestringOptional
The role or roles to set for the team user. Current roles include admin, database, email, web.

Response — normalized as { ok, data, errors[], warnings[] }; data contains:

Payload varies by call.

suspend_team_user GET#

Suspend a team user

This function immediately suspends a team user.

userstringRequired
The username of the team user.
reasonstringOptional
The reason for suspension.

Response — normalized as { ok, data, errors[], warnings[] }; data contains:

Payload varies by call.