cPanel/UserManager
cPanel module

UserManager

11 functions, invoked through the cpanel_uapi tool.

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

change_password GET#

Update cPanel account password

This function updates the cPanel account's password.

newpassstringRequired
The new password.
oldpassstringRequired
The current password.
enablemysqlintegerOptional
Whether to update the cPanel account's MySQL password. 1 - Update MySQL password. 0 - Do not update MySQL passowrd.

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

Payload varies by call.

check_account_conflicts GET#

Return Subaccounts and service accounts conflicts

This function lists the other Subaccounts or services accounts that conflict with the specified username.

Note:

If the function returns more than one account, it will return some values multiple times within the return arrays.

full_usernamestringRequired
The Subaccount's username and domain name.

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

accountsobject
An object containing the service accounts that match the queried full_username parameter.
alternate_emailstring
An alternate email address for the Subaccount's user.
avatar_urlstring
The URL to the user's Subaccount profile image file.
can_deleteinteger
Whether the cPanel account user can delete the Subaccount. 1 — Can delete. 0 — Cannot delete.
One of: 1 0
can_set_passwordinteger
Whether the cPanel account user can change the Subaccount's password. 1 — Can change the password. 0 — Cannot change the password. Note: the function returns 0 for Subaccounts that inherit their password from the cPanel account.
One of: 1 0
can_set_quotainteger
Whether the cPanel account user can change the Subaccount's disk usage quota. 1 — Can change the Subaccount's disk usage quota. 0 — Cannot change the Subaccount's disk useage quota.
One of: 1 0
dismissedinteger
Whether the cPanel account user dismissed the merge prompt for the service account. 1 — Dismissed. 0 — Did not dismiss. Note: Only service accounts return this value.
One of: 1 0
dismissed_merge_candidatesarray<any>
A list of the service accounts that the user dismissed the merge prompt for. Note: This array always returns empty. We reserved this return for future use.
domainstring
The Subaccount user's associated domain.
full_usernamestring
The Subaccount's username.
guidstring
The Subaccount's system-assigned unique identifier.
has_expired_inviteinteger
Whether the Subaccount owns an expired invitation. 1 — Owns an expired invitation. 0 — Does not own an expired invitation.
One of: 1 0
has_inviteinteger
Whether the Subaccount owns an active invitation. 1 — Own an active invitation. 0 — Does not own an active invitation.
One of: 1 0
has_siblingsinteger
Whether the service account shares the queried full_username value with another service account. 1 — Shares the service account. 0 — Does not share the service account.
One of: 1 0
invite_expirationinteger
The time at which the new Subaccount invitation will expire. * null — The account does not own an active invitation.
issuesarray<object>
An array of objects containing information about any issues or problems with the Subaccount.
areastring
The affected section of cPanel & WHM.
limitinteger
The set megabyte (MB) quota limit for the affected Subaccount.
messagestring
A description of the issue.
servicestring
The affected service. email ftp * webdisk
One of: email ftp webdisk
typestring
The type of issue. error warning * info
One of: error warning info
usedinteger
The number of megabytes (MB) the account currently uses.
merge_candidatesarray<object>
An array of objects containing the service accounts that the system could merge for this Subaccount.
parent_typestring
The type of account that could own the service account. sub — A Subaccount. hypothetical — A hypothetical Subaccount that does not yet exist, but that the user could create as part of a merge. * null — Not a merge candidate.
One of: sub hypothetical
phone_numberstring
The Subaccount user's phone number, in ITU-T-recommended E.164 format.
real_namestring
The name of the Subaccount user, if provided.
servicesobject
Information about the Subaccount's access to email, FTP, and Web Disk.
specialinteger
Whether the account is a system-created special account that the user cannot remove. 1 — The user can remove the account. 0 — The user cannot remove the account.
One of: 1 0
sub_account_existsinteger
Whether a Subaccount exists with the same username. 1 — Exists. 0 — Does not exist. * null — The account is not a Subaccount.
One of: 1 0
synced_passwordinteger
Whether the user has synchronized the passwords for each of the Subaccount's service accounts. 1 — Synchronized. 0 — Not synchronized. * null — The account is not a Subaccount.
One of: 1 0
typestring
The type of account. sub — A Subaccount. hypothetical — A hypothetical Subaccount that does not yet exist, but that the user could create as part of a merge. service — A service account. cpanel — A cPanel account.
One of: sub hypothetical service cpanel
usernamestring
The username for the Subaccount. Note: This value does not include the domain name.
conflictinteger
Whether the system detected an account conflict. 1 — Conflict. 0 — No conflict.
One of: 1 0

create_user GET#

Create Subaccount

This function creates a Subaccount.

domainstringRequired
The Subaccount user's associated domain that the cPanel account owns.
passwordstringRequired
The Subaccount's password. Note: Email, FTP, and Web Disk services use this password.
usernamestringRequired
The username for the Subaccount. The username can only contain alphanumeric characters, dots (.), hyphens (-), and underscores (_). Note: This value does not include the domain name.
alternate_emailstringOptional
An alternate email address for the Subaccount's user. Note: You must use this parameter if you set the send_invite value to 1.
avatar_urlstringOptional
The URL path to the user's Subaccount profile photo. Note: You must use the HTTPS protocol to prevent mixed content warnings when users view the image from another HTTPS URL. Warning: We reserved this parameter for future use. Do not use this parameter.
phone_numberstringOptional
A phone number for the Subaccount user that conforms to ITU-T's E.164 standards. Warning: We reserved this parameter for future use. Do not use this parameter.
real_namestringOptional
The Subaccount user's first and/or last name.
send_inviteintegerOptional
Whether to send a reset password email to the Subaccount's alternate email address. 1 - Send. 0 - Do not send.
services.email.enabledintegerOptional
Whether to grant the Subaccount email access. 1 - Can access. 0 - Cannot access.
services.email.quotastringOptional
The maximum amount of disk space, in megabytes (MB), allocated to Subaccount'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.email.send_welcome_emailintegerOptional
Whether to send client configuration instructions to the account. 1 - Send the instructions. 0 - Do not send the instructions.
services.ftp.enabledintegerOptional
Whether to grant the Subaccount FTP access. 1 - Can access. 0 - Cannot access.
services.ftp.homedirstringOptional
The Subaccount'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 grant the Subaccount Web Disk access. 1 _ Can access. 0 - Cannot access.
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 Subaccount'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 Subaccount'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 Subaccount'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).
typestringOptional
The type of account. * sub - A Subaccount.

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

Payload varies by call.

delete_user GET#

Delete Subaccount

This function deletes a Subaccount. This function returns only metadata if no other service accounts exist with the same username and domain.

  • If one service account uses the same username and domain, the function returns the service account's information.
  • If two or more service accounts use the same username and domain, the function returns a hypothetical Subaccount.

Note:

  • A hypothetical Subaccount consists of two or more service accounts that use the same username and domain.
  • This function returns only metadata if the specified username and domain do not match any service accounts or hypothetical Subaccounts.
domainstringRequired
The Subaccount's associated domain. The domain must be one that the cPanel account owns.
usernamestringRequired
The Subaccount's username. * Characters — a-z, A-Z, 0-9, dot (.), hyphen (-), underscore (_) Note: This value does not include the domain name.

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

alternate_emailstring
An alternate email address for the account's user.
avatar_urlstring
The user's account profile photo. The URL must point to an image file.
can_deleteinteger
Whether the cPanel account user can delete the account. 1 - Can delete. 0 - Cannot delete.
One of: 0 1
can_set_passwordinteger
Whether the cPanel account user can change the account's password. 1 - Can change password. 0 - Cannot change password. Note: The function returns 0 for accounts that inherit their password from the cPanel account.
One of: 0 1
can_set_quotainteger
Whether the cPanel account user can change the account's disk usage quota. 1 - Can change quota. 0 - Cannot change quota.
One of: 0 1
dismissedinteger
Whether the cPanel account user dismissed the merge prompt for the service account. 1 - Dismissed prompt. 0 - Did not dismiss prompt. Note: Only service accounts return this value.
One of: 0 1
dismissed_merge_candidatesarray<object>
An array of objects that represent the service accounts that the user dismissed the merge prompt for. This array will always return empty. Note: We reserved this return for future use.
domainstring
The account user's associated domain.
full_usernamestring
The account's username and domain name, separated by the @ character.
guidstring
The account unique identifier.
has_expired_inviteinteger
Whether the Subaccount owns an expired invitation. 1 - Owns an expired invitation. 0 - Does not own an expired invitation.
One of: 0 1
has_inviteinteger
Whether the Subaccount owns an active invitation. 1 - Owns an invitation. 0 - Does not own an invitation.
One of: 0 1
has_siblingsinteger
Whether the service account shares a full_username value with another service account. 1 - Shares. 0 - Does not share.
One of: 0 1
invite_expirationinteger
The time at which the new Subaccount invitation will expire, given as a valid Unix epoch time or null. If the account does not own an active invitation, this value returns null.
issuesarray<any>
Information about any issues or problems with the account.
areastring
The affected section of cPanel & WHM.
limitinteger
The set quota megabyte (MB) limit for the affected account.
messagestring
The description of the issue.
servicestring
The affected service. email ftp * webdisk
One of: email ftp webdisk
typestring
The type of issue. error warning * info
One of: error warning info
usedinteger
The number of megabytes (MB) that the account currently uses.
merge_candidatesarray<object>
The service accounts that the system could merge for this account. Note: You can find descriptions for this array's returns within this table.
alternate_emailstring
avatar_urlstring
can_deleteinteger
can_set_passwordinteger
can_set_quotainteger
dismissedinteger
dismissed_merge_candidatesarray<string>
domainstring
full_usernamestring
guidstring
has_expired_inviteinteger
has_inviteinteger
has_siblingsinteger
invite_expirationinteger
issuesarray<string>
merge_candidatesarray<string>
parent_typestring
phone_numberstring
real_namestring
servicesobject
specialinteger
sub_account_existsinteger
synced_passwordinteger
typestring
usernamestring
parent_typestring
The type of account that could own the service account. sub - An account. hypothetical - A hypothetical account does not yet exist, but that the user could create as part of a merge. * null - Not a merge candidate.
One of: sub hypothetical
phone_numberstring
The account user's phone number. * A valid phone number that conforms to ITU-T's E.164-recommended standard for the representation of telephone numbers.
real_namestring
The name of the account's user. A first name, a last name, or a first name and last name. An empty string.
servicesobject
Information about the account's access to email, FTP, and Web Disk.
emailobject
Information that indicates the account's email status.
enabledinteger
Whether the account can access Webmail, POP, and IMAP services. 1 - Can access. 0 - Cannot access.
One of: 1 0
quotainteger
The account's email disk space quota. The set quota megabyte (MB) limit for the account's email disk space. 0 - Unlimited.
ftpobject
Information about the account's FTP status.
enabledinteger
Whether the account can access FTP. 1 - Can access. 0 - Cannot access.
One of: 1 0
homedirstring
The account's FTP home directory. * A valid path, relative to the cPanel account's home directory.
quotainteger
The account's FTP disk space quota. An integer that represents the account's maximum FTP disk usage, in megabytes (MB). 0 - Unlimited.
webdiskobject
Information about the account's Web Disk status.
enabledinteger
Whether the account can access Web Disk. 1 - Can access. 0 - Cannot access.
One of: 1 0
homedirstring
The account's Web Disk directory. * A valid path, relative to the cPanel account's home directory.
permsstring
Whether to grant write permissions to the account. ro - Read-only permissions. rw - Read and write permissions.
privateinteger
Whether to set the Web Disk directory's permissions to public or private. 1 - Private (0700). 0 - Public (0755).
One of: 1 0
specialinteger
Whether the account is a system-created special account that the user cannot remove. 1 - A special account. 0 - Not a special account.
One of: 1 0
sub_account_existsinteger
Whether an account exists with the same username. 1 - Exists. 0 - Does not exist. * null - The account is not a service account.
One of: 1 0
synced_passwordinteger
Whether the user has synchronized the passwords for each of the account's service accounts. 1 - Synchronized. 0 - Not synchronized. * null - The account is not a Subaccount
One of: 1 0
typestring
The type of account. hypothetical - A hypothetical account that does not exist, but that the user could create as part of a merge. service - A service account.
One of: hypothetical service
usernamestring
The account username. The username must meet the account name limitations. * Characters - a-z, A-Z, 0-9, dot (.), hyphen (-), underscore (_) Note:: This value does not include the domain name.

dismiss_merge GET#

Remove service account link request

This function removes a service account as a link candidate to create a subaccount or link to a subaccount. When you use this function, the system removes the Link option in cPanel's User Manager interface (_cPanel >> Home >> Preferences >> User Manager_).

Note:

You must use at least one of the following parameters:

  • services.email.dismiss
  • services.ftp.dismiss
  • services.webdisk.dismiss
domainstringRequired
The service account's associated domain.
usernamestringRequired
The username for the service account. Note: This parameter does not include the domain name.
services.email.dismissintegerOptional
Whether to dismiss the merge of the email service account. 1 - Dismiss. 0 - Do not dismiss.
services.ftp.dismissintegerOptional
Whether to dismiss the merge of the FTP service account. 1 - Dismiss. 0 - Do not dismiss.
services.webdisk.dismissintegerOptional
Whether to dismiss the merge of the Web Disk service account. 1 - Dismiss. 0 - Do not dismiss.

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

Payload varies by call.

edit_user GET#

Update Subaccount settings

This function edits a Subaccount.

domainstringRequired
The Subaccount user's associated domain. A domain that the cPanel account owns.
usernamestringRequired
The Subaccount's username. Length - 64 characters. Characters - a-z, A-Z, 0-9, dot (.), hyphen (-), underscore (_). Note: This value does not include the domain name.
alternate_emailstringOptional
An alternate email address for the Subaccount's user. Note: The cPanel account user could use this email address to contact the Subaccount user if their primary email address's domain is unavailable.
avatar_urlstringOptional
Warning: We reserved this parameter for future use. Do not use this parameter. The user's Subaccount profile photo. Note: You must use the HTTPS protocol to prevent mixed content warnings when users view the photo from another HTTPS URL.
passwordstringOptional
The Subaccount's new password. Note: The Subaccount uses this password for email, FTP, and Web Disk services.
phone_numberstringOptional
The Subaccount user's phone number. Warning: We reserved this parameter for future use. Do not use this parameter. The number conforms to the ITU-T's E.164-recommended standard for the representation of telephone numbers.
real_namestringOptional
The Subaccount user's name. A first name. A last name. A first name and last name. An empty string.
services.email.enabledintegerOptional
Whether to grant the Subaccount email access. 1 - Can access. 0 - Cannot access.
services.email.quotaintegerOptional
The maximum amount of disk space, in megabytes (MB), that the subaccount's email account may use. If you do not declare a value, the system defaults to the defined system value. Note: This value cannot be greater than the maximum email quota. * 0 or unlimited - The subaccount possesses unlimited disk space.
services.ftp.enabledintegerOptional
Whether to grant the Subaccount FTP access. 1 - Can access. 0 - Cannot access.
services.ftp.homedirstringOptional
The Subaccount's FTP home directory. Note: This parameter is required if you enable FTP access. A relative path from the cPanel account's home directory. Note: The specified directory must exist.
services.webdisk.enabledintegerOptional
Whether to grant the Subaccount Web Disk access. 1 - Can access. 0 - Cannot access.
services.webdisk.enabledigestintegerOptional
Whether to enable Web Disk digest authentication. Notes: 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. 1 - Enabled 0 - Disabled.
services.webdisk.homedirstringOptional
The Subaccount's Web Disk home directory. Note: This parameter is required if you enable Web Disk access. A relative path from the cPanel account's home directory.
services.webdisk.permsstringOptional
Whether to grant write permissions to the Subaccount. Note: The services.webdisk.homedir parameter determines the Subaccount's Web Disk home directory. ro - Read-only permissions. rw - Read and write permissions.
services.webdisk.privateintegerOptional
Whether to set the Web Disk directory's permissions to public or private. 1 - Private (0700). 0 - Public (0755).
typestringOptional
The type of account. * sub - A Subaccount.

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

dismissed_merge_candidatesarray<any>
An array of objects of service candidates that the system dismissed from merges.

list_users GET#

Return cPanel account's Subaccounts

This function lists the cPanel account's Subaccounts.

flatintegerOptional
Whether to return Subaccounts with the same name under the merge_candidates array. 1 - Do not return. 0 - Return.

Response — normalized as { ok, data, errors[], warnings[] }; data is an array of:

alternate_emailstring
An alternate email address for the subaccount's user.
avatar_urlstring
The user's subaccount profile photo.
can_deleteinteger
Whether the cPanel account user can delete the subaccount. 1 - Can delete. 0 - Cannot delete.
One of: 0 1
can_set_passwordinteger
Whether the cPanel account user can change the subaccount's password. 1 - Can change. 0 - Cannot change. Note: The function returns a 0 value for subaccounts that inherit their password from the cPanel account.
One of: 0 1
can_set_quotainteger
Whether the cPanel account user can change the subaccount's disk usage quota. 1 - Can change. 0 - Cannot change.
One of: 0 1
dismissedinteger
Whether the cPanel account user dismissed the merge prompt for the service account. 1 - Dismissed. 0 - Did not dismiss. Note: Only service accounts return this value.
One of: 0 1
dismissed_merge_candidatesarray<string>
An array of objects containing information about service candidates that the system dismissed from merges.
domainstring
The subaccount user's associated domain.
full_usernamestring
The subaccount's username and domain name.
guidstring
The subaccount unique identifier.
has_expired_inviteinteger
Whether an expired account login invitation exists. 1 - Expired account invitation exists. 0 - Expired account invitation does not exist.
One of: 0 1
has_inviteinteger
Whether an account login invitation exists. 1 - Account invitation exists. 0 - Account invitation does not exist.
One of: 0 1
has_siblingsinteger
Whether the service account shares a full_username value with another service account. 1 - Shares. 0 - Does not share.
One of: 0 1
invite_expirationinteger
When the invitation expires.
issuesarray<object>
Information about any issues or problems with the subaccount.
areastring
The affected section of cPanel & WHM.
limitinteger
The set quota megabyte (MB) limit for the affected subaccount.
messagestring
The description of the issue.
servicestring
The affected service.
One of: email ftp webdisk
typestring
The type of issue.
One of: error warning info
usedinteger
The number of megabytes (MB) that the account currently uses.
merge_candidatesarray<string>
An array of objects that represents the service accounts that the system could merge for this subaccount.
parent_typestring
The type of account that could own the service account. sub - A subaccount. hypothetical - A hypothetical subaccount that does not yet exist, but the user could create as part of a merge. * null - Not a merge candidate.
One of: sub hypothetical
phone_numberstring
The subaccount user's phone number. A valid phone number that conforms to ITU-T's E.164 -recommended standard for the representation of telephone numbers.
real_namestring
The name of the subaccount's user.
servicesobject
An object containing information about the subaccount's access to email, FTP, and Web Disk.
emailobject
An object containing the information that indicates the subaccount's email status.
enabledinteger
Whether the subaccount can access Webmail, POP, and IMAP services. 1 - Can access. 0 - Cannot access.
One of: 0 1
quotainteger
The maximum amount of disk space allocated to subaccount's email account.
ftpobject
An object containing the information that indicates the subaccount's FTP status.
enabledinteger
Whether the subaccount can access FTP. 1 - Can access. 0 - Cannot access.
One of: 0 1
homedirstring
The subaccount's FTP home directory relative to the cPanel account's home.
quotainteger
The subaccount's FTP disk space quota. * 0 - Unlimited.
specialinteger
Whether the account is a system-created special account that the user cannot remove. 1 - A special account. 0 - Not a special account.
One of: 0 1
webdiskobject
An object containing information that indicates the subaccount's Web Disk status.
enabledinteger
Whether the subaccount can access Web Disk. 1 - Can access. 0 - Cannot access.
One of: 0 1
homedirstring
The subaccount's Web Disk home directory relative to the cPanel account's home directory.
permsstring
Whether to grant write permissions to the subaccount. ro - Read-only permissions. rw - Read and write permissions.
One of: ro rw
privateinteger
Whether to set the Web Disk directory's permissions to public or private. 1 - Private (0700). 0 - Public (0755).
One of: 0 1
specialinteger
Whether the account is a system-created special account that the user cannot remove. 1 — A special account. 0 — Not a special account.
One of: 0 1
sub_account_existsinteger
Whether a subaccount exists with the same username. 1 - Exists. 0 - Does not exist. Note: The function returns a null value if the account is not a service account.
One of: 0 1
synced_passwordinteger
Whether the user has synchronized the passwords for each of the subaccount's service accounts. 1 - Synchronized. 0 - Not synchronized. Note: The function returns a null value if the account is not a subaccount.
One of: 0 1
typestring
The type of account. sub - A subaccount. hypothetical - A hypothetical subaccount that does not exist, but that the user could create as part of a merge. service - A service account. cpanel - The cPanel account.
One of: sub hypothetical service cpanel
usernamestring
The username for the subaccount. A username that meets the subaccount name limitations. - Length 64 characters. - Characters a-z, A-Z, 0-9, dot (.), hyphen (-), underscore (_). Note: This value does not include the domain name.

lookup_service_account GET#

Return service account's information

This function lists a service account's information.

full_usernamestringRequired
The full username for the system account.
typestringRequired
The type of system account. email ftp * webdisk

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

dismissed_merge_candidatesarray<any>
An array of objects of service candidates that the system dismissed from merges.

lookup_user GET#

Return Subaccount's information

This function lists a single Subaccount's information.

guidstringRequired
The Subaccount's unique identifier.

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

Payload varies by call.

merge_service_account GET#

Register service account to Subaccount

This function links service accounts to subaccounts and creates a subaccount if one does not exist.

Note:

You can only link email, FTP, or Web Disk accounts.

Important

You must use at least one of the following parameters:

  • services.email.merge
  • services.ftp.merge
  • services.webdisk.merge

To link multiple service accounts, the service accounts must share the same username and domain.

domainstringRequired
The service account's associated domain.
usernamestringRequired
The username for the service account that meets the account name limitations. Length - 64 characters Characters — a-z, A-Z, 0-9, dot (.), hyphen (-), underscore (_). Note: This value does not include the domain name.
services.email.mergeintegerOptional
Whether to link the email account to the subaccount. 1 - Merge. 0 - Do not merge.
services.ftp.mergeintegerOptional
Whether to link the FTP account to the subaccount. 1 - Merge. 0 - Do not merge.
services.webdisk.mergeintegerOptional
Whether to link the Web Disk account to the subaccount. 1 - Merge. 0 - Do not merge.

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

alternate_emailstring
An alternate email address for the subaccount's user.
avatar_urlstring
The user's subaccount profile photo.
can_deleteinteger
Whether the cPanel account user can delete the subaccount. 1 - Can delete. 0 - Cannot delete.
One of: 0 1
can_set_passwordinteger
Whether the cPanel account user can change the subaccount's password. 1 - Can change. 0 - Cannot change. Note: The function returns a 0 value for subaccounts that inherit their password from the cPanel account.
One of: 0 1
can_set_quotainteger
Whether the cPanel account user can change the subaccount's disk usage quota. 1 - Can change. 0 - Cannot change.
One of: 0 1
dismissedinteger
Whether the cPanel account user dismissed the merge prompt for the service account. Note: Only service accounts return this value. 1 - Dismissed. 0 - Did not dismiss.
One of: 0 1
dismissed_merge_candidatesarray<object>
An array of objects of service candidates that the system dismissed from merges.
alternate_emailstring
An alternate email address for the subaccount's user.
avatar_urlstring
The user's subaccount profile photo.
can_deleteinteger
Whether the cPanel account user can delete the subaccount. 1 - Can delete. 0 - Cannot delete.
One of: 0 1
can_set_passwordinteger
Whether the cPanel account user can change the subaccount's password. 1 - Can change. 0 - Cannot change. Note: The function returns a 0 value for subaccounts that inherit their password from the cPanel account.
One of: 0 1
can_set_quotainteger
Whether the cPanel account user can change the subaccount's disk usage quota. 1 - Can change. 0 - Cannot change.
One of: 0 1
domainstring
The subaccount user's associated domain that the cPanel account owns.
full_usernamestring
The subaccount's username and domain name.
guidstring
The subaccount unique identifier. The system assigned unique value.
has_siblingsinteger
Whether the service account shares a full_username value with another service account. 1 - Shares. 0 - Does not share.
One of: 0 1
issuesarray<object>
Information about any issues or problems with the subaccount.
areastring
The affected section of cPanel & WHM.
limitinteger
The set quota megabyte (MB) limit for the affected subaccount.
messagestring
The description of the issue.
servicestring
The affected service. email ftp * webdisk
One of: email ftp webdisk
typestring
The type of issue. error warning * info
One of: error warning info
usedinteger
The number of megabytes (MB) that the account currently uses.
parent_typestring
The type of account that could own the service account. sub - A subaccount. hypothetical - A hypothetical subaccount that does not yet exist, but the user could create as part of a merge. * null - Not a merge candidate.
One of: sub hypothetical
phone_numberstring
The subaccount user's phone number.
real_namestring
The name of the subaccount's user. A first name. Last name. First name and last name. An empty string.
servicesobject
This object contains information about the subaccount's access to email, FTP, and Web Disk.
emailobject
This object contains the information that indicates the subaccount's email status.
ftpobject
This object contains the information that indicates the subaccount's FTP status.
webdiskobject
This object contains information that indicates the subaccount's Web Disk status.
specialinteger
Whether the account is a system-created special account that the user cannot remove. 1 - A special account. 0 - Not a special account.
One of: 0 1
sub_account_existsinteger
Whether a subaccount exists with the same username. 1 - Exists. 0 - Does not exist. Note: The function returns a null value if the account is not a service account.
One of: 0 1
synced_passwordinteger
Whether the user has synchronized the passwords for each of the subaccount's service accounts. 1 - Synchronized. 0 - Not synchronized. Note: The function returns a null value if the account is not a subaccount.
One of: 0 1
typestring
The type of account. sub - A subaccount. hypothetical - A hypothetical subaccount that does not exist, but that the user could create as part of a merge. service - A service account. cpanel - The cPanel account.
One of: sub hypothetical service cpanel
usernamestring
The username for the subaccount.
domainstring
The subaccount user's associated domain. A domain that the cPanel account owns.
full_usernamestring
The subaccount's username and domain name.
guidstring
The subaccount unique identifier. The system assigned unique value.
has_expired_inviteinteger
Whether an expired account login invitation exists. 1 - Expired account invitation exists. 0 - Expired account invitation does not exist.
One of: 0 1
has_inviteinteger
Whether an account login invitation exists. 1 - Account invitation exists. 0 - Account invitation does not exist.
One of: 0 1
has_siblingsinteger
Whether the service account shares a full_username value with another service account. 1 - Shares. 0 - Does not share.
One of: 0 1
invite_expirationinteger
When the invitation expires.
issuesarray<object>
Information about any issues or problems with the subaccount.
areastring
The affected section of cPanel & WHM.
limitinteger
The set quota megabyte (MB) limit for the affected subaccount.
messagestring
The description of the issue.
servicestring
The affected service. email ftp * webdisk
One of: email ftp webdisk
typestring
The type of issue. error warning * info
One of: error warning info
usedinteger
The number of megabytes (MB) that the account currently uses.
merge_candidatesarray<object>
An array of objects that represents the service accounts that the system could merge for this subaccount.
alternate_emailstring
An alternate email address for the subaccount's user.
avatar_urlstring
The user's subaccount profile photo.
can_deleteinteger
Whether the cPanel account user can delete the subaccount. 1 - Can delete. 0 - Cannot delete.
One of: 0 1
can_set_passwordinteger
Whether the cPanel account user can change the subaccount's password. 1 - Can change. 0 - Cannot change. Note: The function returns a 0 value for subaccounts that inherit their password from the cPanel account.
One of: 0 1
can_set_quotainteger
Whether the cPanel account user can change the subaccount's disk usage quota. 1 - Can change. 0 - Cannot change.
One of: 0 1
domainstring
The subaccount user's associated domain. A domain that the cPanel account owns.
full_usernamestring
The subaccount's username and domain name.
guidstring
The subaccount unique identifier. The system assigned unique value.
has_siblingsinteger
Whether the service account shares a full_username value with another service account. 1 - Shares. 0 - Does not share.
One of: 0 1
issuesarray<object>
Information about any issues or problems with the subaccount.
areastring
The affected section of cPanel & WHM.
limitinteger
The set quota megabyte (MB) limit for the affected subaccount.
messagestring
The description of the issue.
servicestring
The affected service. email ftp * webdisk
One of: email ftp webdisk
typestring
The type of issue. error warning * info
One of: error warning info
usedinteger
The number of megabytes (MB) that the account currently uses.
parent_typestring
The type of account that could own the service account. sub - A subaccount. hypothetical - A hypothetical subaccount that does not yet exist, but the user could create as part of a merge. * null - Not a merge candidate.
One of: sub hypothetical
phone_numberstring
The subaccount user's phone number.
real_namestring
The name of the subaccount's user. A first name. Last name. First name and last name. An empty string.
servicesobject
This object contains information about the subaccount's access to email, FTP, and Web Disk.
emailobject
This object contains the information that indicates the subaccount's email status.
ftpobject
This object contains the information that indicates the subaccount's FTP status.
webdiskobject
This object contains information that indicates the subaccount's Web Disk status.
specialinteger
Whether the account is a system-created special account that the user cannot remove. 1 - A special account. 0 - Not a special account.
One of: 0 1
sub_account_existsinteger
Whether a subaccount exists with the same username. 1 - Exists. 0 - Does not exist. Note: The function returns a null value if the account is not a service account.
One of: 0 1
synced_passwordinteger
Whether the user has synchronized the passwords for each of the subaccount's service accounts. 1 - Synchronized. 0 - Not synchronized. Note: The function returns a null value if the account is not a subaccount.
One of: 0 1
typestring
The type of account. sub - A subaccount. hypothetical - A hypothetical subaccount that does not exist, but that the user could create as part of a merge. service - A service account. cpanel - The cPanel account.
One of: sub hypothetical service cpanel
usernamestring
The username for the service account that meets the account name limitations. Length - 64 characters Characters — a-z, A-Z, 0-9, dot (.), hyphen (-), underscore (_). Note: This value does not include the domain name.
parent_typestring
The type of account that could own the service account. sub - A subaccount. hypothetical - A hypothetical subaccount that does not yet exist, but the user could create as part of a merge. * null - Not a merge candidate.
One of: sub hypothetical
phone_numberstring
The subaccount user's phone number.
real_namestring
The name of the subaccount's user. A first name. Last name. First name and last name. An empty string.
servicesobject
This object contains information about the subaccount's access to email, FTP, and Web Disk.
emailobject
This object contains the information that indicates the subaccount's email status.
enabledinteger
Whether the subaccount can access Webmail, POP, and IMAP services. 1 - Can access. 0 - Cannot access.
One of: 0 1
quotainteger
The maximum amount of disk space allocated to subaccount's email account. A positive integer that represents the maximum disk space that the subaccount may use, in megabytes (MB). Note: This function will not return 0 as a value.
ftpobject
This object contains the information that indicates the subaccount's FTP status.
enabledinteger
Whether the subaccount can access FTP. 1 - Can access. 0 - Cannot access.
One of: 0 1
homedirstring
The subaccount's FTP home directory.
quotainteger
The subaccount's FTP disk space quota. >= 1 - Represents the maximum disk space that the subaccount may use, in megabytes (MB). 0 - Unlimited.
webdiskobject
This object contains information that indicates the subaccount's Web Disk status.
enabledinteger
Whether the subaccount can access Web Disk. 1 - Can access. 0 - Cannot access.
One of: 0 1
homedirstring
The subaccount's Web Disk home directory.
permsstring
Whether to grant write permissions to the subaccount. ro - Read-only permissions. rw - Read and write permissions.
privateinteger
Whether to set the Web Disk directory's permissions to public or private. 1 - Private (0700). 0 - Public (0755).
One of: 0 1
specialinteger
Whether the account is a system-created special account that the user cannot remove. 1 - A special account. 0 - Not a special account.
One of: 0 1
sub_account_existsinteger
Whether a subaccount exists with the same username. 1 - Exists. 0 - Does not exist. Note: The function returns a null value if the account is not a service account.
One of: 0 1
synced_passwordinteger
Whether the user has synchronized the passwords for each of the subaccount's service accounts. 1 - Synchronized. 0 - Not synchronized. Note: The function returns a null value if the account is not a subaccount.
One of: 0 1
typestring
The type of account. sub - A subaccount. hypothetical - A hypothetical subaccount that does not exist, but that the user could create as part of a merge. service - A service account. cpanel - The cPanel account.
usernamestring
The username for the subaccount. The username for the service account that meets the account name limitations. Length - 64 characters Characters — a-z, A-Z, 0-9, dot (.), hyphen (-), underscore (_). Note: This value does not include the domain name.