This action may result in team users gaining access to team owner level privileges.
SecurityBasicAuth
Request
query Parameters
email1
required
string
The contact email for the new team user.
Example: email1=teamuser@example.com
user
required
string
The username of the team user. Follows cPanel standards.
Example: user=teamuser
activation_email
integer
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.
Example: activation_email=1
email2
string
The secondary email for the new team user.
Example: email2=teamuser-backup@example.com
integer or string
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'.
Examples:
expire_date=120days
expire_date=1649948169
expire_reason
string
The reason for expiration.
Example: expire_reason=teamUser gave a two week notice.
notes
string
Notes about the new team user. This field should not contain private information. Maximum of 100 characters.
Example: notes=This is a note about teamuser
password
string
The password to set for the new team user.
Note:
You must pass either the password or activation_email parameter.
Example: password=securepassword
roles
string
A comma-separated list of roles assigned to the new team user. Current roles include admin, database, email, web.
Example: roles=email,database
services.email.enabled
integer
Default: 0
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.
Enum:01
Example: services.email.enabled=1
services.email.quota
string
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.
Example: services.email.quota=500
services.ftp.enabled
integer
Default: 0
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.
Enum:01
Example: services.ftp.enabled=1
services.ftp.homedir
string <path>
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.
Example: services.ftp.homedir=/Teamusername
services.webdisk.enabled
integer
Default: 0
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.
Enum:01
Example: services.webdisk.enabled=1
services.webdisk.enabledigest
integer
Default: 0
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.
Enum:01
Example: services.webdisk.enabledigest=0
services.webdisk.homedir
string <path>
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.
Example: services.webdisk.homedir=/Teamusername
services.webdisk.perms
string
Default: "rw"
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.
Example: services.webdisk.perms=rw
services.webdisk.private
integer
Default: 0
Whether to set the directory's permissions to public or private.
1 - Private (0700).
0 - Public (0755).
Enum:01
Example: services.webdisk.private=1
Responses
200
HTTP Request was successful.
Response Schema: application/json
apiversion
integer
The version of the API.
func
string
The name of the method called.
module
string
The name of the module called.
object
get/Team/add_team_user
Request samples
CLI
URL
LiveAPI Perl
LiveAPI PHP
uapi --output=jsonpretty \--user=username \
Team \
add_team_user \user='teamuser'\email1='teamuser@example.com'