UAPI Functions - UserManager::list_users

Guide to UAPI

Backup

Backup:: fullbackup_to_ftp

Backup:: fullbackup_to_homedir

Backup:: fullbackup_to_scp_with_key

Backup:: fullbackup_to_scp_with_password

Backup:: list_backups

Backup:: restore_databases

Backup:: restore_email_filters

Backup:: restore_email_forwarders

Backup:: restore_files

Bandwidth

Bandwidth:: get_enabled_protocols

Bandwidth:: get_retention_periods

Bandwidth:: query

Batch

Batch:: strict

BlockIP

BlockIP:: add_ip

BlockIP:: remove_ip

BoxTrapper

BoxTrapper:: blacklist_messages

BoxTrapper:: delete_messages

BoxTrapper:: deliver_messages

BoxTrapper:: get_configuration

BoxTrapper:: get_email_template

BoxTrapper:: get_forwarders

BoxTrapper:: get_log

BoxTrapper:: get_message

BoxTrapper:: get_status

BoxTrapper:: ignore_messages

BoxTrapper:: list_email_templates

BoxTrapper:: list_queued_messages

BoxTrapper:: process_messages

BoxTrapper:: reset_email_template

BoxTrapper:: save_configuration

BoxTrapper:: save_email_template

BoxTrapper:: set_forwarders

BoxTrapper:: set_status

BoxTrapper:: whitelist_messages

Brand

Brand:: read

Branding

Branding:: file

Branding:: get_applications

Branding:: get_application_information

Branding:: get_available_applications

Branding:: get_information_for_applications

Branding:: image

Branding:: include

Branding:: spritelist

CacheBuster

CacheBuster:: read

CacheBuster:: update

CCS

CCS:: add_delegate

CCS:: list_delegates

CCS:: list_users

CCS:: remove_delegate

CCS:: update_delegate

Chkservd

Chkservd:: get_exim_ports

Chkservd:: get_exim_ports_ssl

Chrome

Chrome:: get_dom

Contactus

Contactus:: is_enabled

cPAddons

cPAddons:: get_available_addons

cPAddons:: get_instance_settings

cPAddons:: list_addon_instances

cPGreyList

cPGreyList:: disable_all_domains

cPGreyList:: disable_domains

cPGreyList:: enable_all_domains

cPGreyList:: enable_domains

cPGreyList:: has_greylisting_enabled

cPGreyList:: list_domains

DAV

DAV:: disable_shared_global_addressbook

DAV:: enable_shared_global_addressbook

DAV:: get_calendar_contacts_config

DAV:: has_shared_global_addressbook

DAV:: is_dav_service_enabled

DAV:: is_horde_enabled

DCV

DCV:: check_domains_via_dns

DCV:: check_domains_via_http

DCV:: ensure_domains_can_pass_dcv

DirectoryIndexes

DirectoryIndexes:: get_indexing

DirectoryIndexes:: list_directories

DirectoryIndexes:: set_indexing

DirectoryPrivacy

DirectoryPrivacy:: add_user

DirectoryPrivacy:: configure_directory_protection

DirectoryPrivacy:: delete_user

DirectoryPrivacy:: is_directory_protected

DirectoryPrivacy:: list_directories

DirectoryPrivacy:: list_users

DirectoryProtection

DirectoryProtection:: list_directories

DomainInfo

DomainInfo:: domains_data

DomainInfo:: list_domains

DomainInfo:: main_domain_builtin_subdomain_aliases

DomainInfo:: single_domain_data

DNS

DNS:: ensure_domains_reside_only_locally

DNS:: has_local_authority

DNS:: lookup

DNSSEC

DNSSEC:: activate_zone_key

DNSSEC:: add_zone_key

DNSSEC:: deactivate_zone_key

DNSSEC:: disable_dnssec

DNSSEC:: enable_dnssec

DNSSEC:: export_zone_dnskey

DNSSEC:: export_zone_key

DNSSEC:: fetch_ds_records

DNSSEC:: import_zone_key

DNSSEC:: remove_zone_key

DNSSEC:: set_nsec3

DNSSEC:: unset_nsec3

DynamicDNS

DynamicDNS:: create

DynamicDNS:: delete

DynamicDNS:: list

DynamicDNS:: recreate

DynamicDNS:: set_description

Email

Email:: account_name

Email:: add_auto_responder

Email:: add_domain_forwarder

Email:: add_forwarder

Email:: add_list

Email:: add_mailman_delegates

Email:: add_mx

Email:: add_pop

Email:: add_spam_filter

Email:: browse_mailbox

Email:: change_mx

Email:: check_fastmail

Email:: check_pipe_forwarder

Email:: count_auto_responders

Email:: count_filters

Email:: count_forwarders

Email:: count_lists

Email:: count_pops

Email:: delete_auto_responder

Email:: delete_domain_forwarder

Email:: delete_filter

Email:: delete_forwarder

Email:: delete_held_messages

Email:: delete_list

Email:: delete_mx

Email:: delete_pop

Email:: disable_filter

Email:: disable_mailbox_autocreate

Email:: disable_spam_assassin

Email:: disable_spam_autodelete

Email:: disable_spam_box

Email:: dispatch_client_settings

Email:: edit_pop_quota

Email:: enable_filter

Email:: enable_mailbox_autocreate

Email:: enable_spam_assassin

Email:: enable_spam_box

Email:: fetch_charmaps

Email:: fts_rescan_mailbox

Email:: generate_mailman_otp

Email:: get_auto_responder

Email:: get_charsets

Email:: get_client_settings

Email:: get_default_email_quota

Email:: get_default_email_quota_mib

Email:: get_disk_usage

Email:: get_filter

Email:: get_held_message_count

Email:: get_lists_total_disk_usage

Email:: get_mailbox_autocreate

Email:: get_mailman_delegates

Email:: get_main_account_disk_usage

Email:: get_main_account_disk_usage_bytes

Email:: get_max_email_quota

Email:: get_max_email_quota_mib

Email:: get_pop_quota

Email:: get_spam_settings

Email:: get_webmail_settings

Email:: has_delegated_mailman_lists

Email:: has_plaintext_authentication

Email:: hold_outgoing

Email:: is_integer

Email:: list_auto_responders

Email:: list_default_address

Email:: list_domain_forwarders

Email:: list_filters

Email:: list_filters_backups

Email:: list_forwarders

Email:: list_forwarders_backups

Email:: list_lists

Email:: list_mail_domains

Email:: list_mxs

Email:: list_pops

Email:: list_pops_with_disk

Email:: list_system_filter_info

Email:: passwd_list

Email:: passwd_pop

Email:: release_outgoing

Email:: remove_mailman_delegates

Email:: reorder_filters

Email:: set_always_accept

Email:: set_default_address

Email:: set_list_privacy_options

Email:: stats_db_status

Email:: store_filter

Email:: suspend_incoming

Email:: suspend_login

Email:: suspend_outgoing

Email:: trace_delivery

Email:: trace_filter

Email:: unsuspend_incoming

Email:: unsuspend_login

Email:: unsuspend_outgoing

Email:: verify_password

EmailAuth

EmailAuth:: disable_dkim

EmailAuth:: enable_dkim

EmailAuth:: ensure_dkim_keys_exist

EmailAuth:: fetch_dkim_private_keys

EmailAuth:: install_dkim_private_keys

EmailAuth:: install_spf_records

EmailAuth:: validate_current_dkims

EmailAuth:: validate_current_ptrs

EmailAuth:: validate_current_spfs

ExternalAuthentication

ExternalAuthentication:: add_authn_link

ExternalAuthentication:: configured_modules

ExternalAuthentication:: get_authn_links

ExternalAuthentication:: has_external_auth_modules_configured

ExternalAuthentication:: remove_authn_link

Features

Features:: get_feature_metadata

Features:: has_feature

Features:: list_features

Fileman

Fileman:: autocompletedir

Fileman:: empty_trash

Fileman:: get_file_content

Fileman:: get_file_information

Fileman:: list_files

Fileman:: save_file_content

Fileman:: transcode

Fileman:: upload_files

Ftp

Ftp:: add_ftp

Ftp:: allows_anonymous_ftp

Ftp:: allows_anonymous_ftp_incoming

Ftp:: delete_ftp

Ftp:: ftp_exists

Ftp:: get_ftp_daemon_info

Ftp:: get_port

Ftp:: get_quota

Ftp:: get_welcome_message

Ftp:: kill_session

Ftp:: list_ftp

Ftp:: list_ftp_with_disk

Ftp:: list_sessions

Ftp:: passwd

Ftp:: server_name

Ftp:: set_anonymous_ftp

Ftp:: set_anonymous_ftp_incoming

Ftp:: set_homedir

Ftp:: set_quota

Ftp:: set_welcome_message

GPG

GPG:: delete_keypair

GPG:: export_public_key

GPG:: export_secret_key

GPG:: generate_key

GPG:: import_key

GPG:: list_public_keys

GPG:: list_secret_keys

ImageManager

ImageManager:: convert_file

ImageManager:: create_thumbnails

ImageManager:: get_dimensions

ImageManager:: resize_image

Integration

Integration:: fetch_url

KnownHosts

KnownHosts:: create

KnownHosts:: delete

KnownHosts:: update

KnownHosts:: verify

LangPHP

LangPHP:: php_get_domain_handler

LangPHP:: php_get_impacted_domains

LangPHP:: php_get_installed_versions

LangPHP:: php_get_system_default_version

LangPHP:: php_get_vhost_versions

LangPHP:: php_ini_get_user_basic_directives

LangPHP:: php_ini_get_user_content

LangPHP:: php_ini_get_user_paths

LangPHP:: php_ini_set_user_basic_directives

LangPHP:: php_ini_set_user_content

LangPHP:: php_set_vhost_versions

LastLogin

LastLogin:: get_last_or_current_logged_in_ip

Locale

Locale:: get_attributes

Locale:: list_locales

Locale:: set_locale

LogManager

LogManager:: get_settings

LogManager:: list_archives

LogManager:: set_settings

Mailboxes

Mailboxes:: expunge_mailbox_messages

Mailboxes:: expunge_messages_for_mailbox_guid

Mailboxes:: get_mailbox_status_list

Mailboxes:: has_utf8_mailbox_names

Mailboxes:: set_utf8_mailbox_names

Market

Market:: cancel_pending_ssl_certificate

Market:: create_shopping_cart

Market:: get_all_products

Market:: get_certificate_status_details

Market:: get_login_url

Market:: get_pending_ssl_certificates

Market:: get_provider_specific_dcv_constraints

Market:: get_providers_list

Market:: get_ssl_certificate_if_available

Market:: process_ssl_pending_queue

Market:: request_ssl_certificates

Market:: set_status_of_pending_queue_items

Market:: set_url_after_checkout

Market:: validate_login_token

Mime

Mime:: add_handler

Mime:: add_hotlink

Mime:: add_mime

Mime:: add_redirect

Mime:: delete_handler

Mime:: delete_hotlink

Mime:: delete_mime

Mime:: delete_redirect

Mime:: get_redirect

Mime:: list_handlers

Mime:: list_hotlinks

Mime:: list_mime

Mime:: list_redirects

Mime:: redirect_info

ModSecurity

ModSecurity:: disable_all_domains

ModSecurity:: disable_domains

ModSecurity:: enable_all_domains

ModSecurity:: enable_domains

ModSecurity:: has_modsecurity_installed

ModSecurity:: list_domains

Mysql

Mysql:: add_host

Mysql:: add_host_note

Mysql :: check_database

Mysql:: create_database

Mysql:: create_user

Mysql:: delete_database

Mysql:: delete_host

Mysql:: delete_user

Mysql:: dump_database_schema

Mysql:: get_host_notes

Mysql:: get_privileges_on_database

Mysql:: get_restrictions

Mysql:: get_server_information

Mysql:: list_databases

Mysql:: list_routines

Mysql:: list_users

Mysql:: locate_server

Mysql:: rename_database

Mysql:: rename_user

Mysql:: repair_database

Mysql:: revoke_access_to_database

Mysql:: set_password

Mysql:: set_privileges_on_database

Mysql:: update_privileges

Notifications

Notifications:: get_notifications_count

NVData

NVData:: get

NVData:: set

Parser

Parser:: firstfile_relative_uri

PassengerApps

PassengerApps:: disable_application

PassengerApps:: edit_application

PassengerApps:: enable_application

PassengerApps:: ensure_deps

PassengerApps:: list_applications

PassengerApps:: register_application

PassengerApps:: unregister_application

PasswdStrength

PasswdStrength:: get_required_strength

Personalization

Personalization::set

Personalization ::get

Postgresql

Postgresql:: create_database

Postgresql:: create_user

Postgresql:: delete_database

Postgresql:: delete_user

Postgresql:: get_restrictions

Postgresql:: grant_all_privileges

Postgresql:: list_databases

Postgresql:: list_users

Postgresql:: rename_database

Postgresql:: rename_user

Postgresql:: rename_user_no_password

Postgresql:: revoke_all_privileges

Postgresql:: set_password

Postgresql:: update_privileges

Pushbullet

Pushbullet:: send_test_message

Quota

Quota:: get_local_quota_info

Quota:: get_quota_info

Resellers

Resellers:: list_accounts

ResourceUsage

ResourceUsage:: get_usages

Restore

Restore:: directory_listing

Restore:: get_users

Restore:: query_file_info

Restore:: restore_file

Server Information

ServerInformation:: get_information

Session

Session:: create_temp_user

Session:: create_webmail_session_for_mail_user

Session:: create_webmail_session_for_mail_user_check_password

Session:: create_webmail_session_for_self

SiteTemplates

SiteTemplates:: list_site_templates

SiteTemplates:: list_user_settings

SiteTemplates:: publish

SpamAssassin

SpamAssassin :: clear_spam_box

SpamAssassin:: get_symbolic_test_names

SpamAssassin:: get_user_preferences

SpamAssassin:: update_user_preference

SSH

SSH:: get_port

SSL

SSL:: add_autossl_excluded_domains

SSL:: can_ssl_redirect

SSL:: check_shared_cert

SSL:: delete_cert

SSL:: delete_csr

SSL:: delete_key

SSL:: delete_ssl

SSL :: disable_mail_sni

SSL:: enable_mail_sni

SSL:: fetch_best_for_domain

SSL:: fetch_cert_info

SSL:: fetch_certificates_for_fqdns

SSL:: fetch_key_and_cabundle_for_certificate

SSL:: find_certificates_for_key

SSL:: find_csrs_for_key

SSL:: generate_cert

SSL:: generate_csr

SSL:: generate_key

SSL:: get_autossl_excluded_domains

SSL:: get_autossl_pending_queue

SSL:: get_autossl_problems

SSL:: get_cabundle

SSL:: get_cn_name

SSL:: install_ssl

SSL:: installed_host

SSL:: installed_hosts

SSL:: is_autossl_check_in_progress

SSL:: is_mail_sni_supported

SSL:: is_sni_supported

SSL:: list_certs

SSL:: list_csrs

SSL:: list_keys

SSL:: list_ssl_items

SSL:: mail_sni_status

SSL:: rebuild_mail_sni_config

SSL:: rebuildssldb

SSL:: remove_autossl_excluded_domains

SSL:: set_autossl_excluded_domains

SSL:: set_cert_friendly_name

SSL:: set_csr_friendly_name

SSL:: set_default_key_type

SSL:: set_key_friendly_name

SSL:: set_primary_ssl

SSL:: set_ssl_share

SSL:: show_cert

SSL:: show_csr

SSL:: show_key

SSL:: start_autossl_check

SSL:: toggle_ssl_redirects_for_domains

SSL:: upload_cert

SSL:: upload_key

StatsBar

StatsBar:: get_stats

Stats

Stats:: get_bandwidth

Stats:: get_site_errors

Stats:: list_sites

Stats:: list_stats_by_domain

StatsManager

StatsManager:: get_configuration

StatsManager:: save_configuration

Styles

Styles:: current

Styles:: list

Styles:: set_default

Styles:: update

SubDomain

SubDomain:: addsubdomain

Themes

Themes:: get_theme_base

Themes:: list

Themes:: update

Tokens

Tokens:: create_full_access

Tokens:: list

Tokens:: rename

Tokens:: revoke

TwoFactorAuth

TwoFactorAuth:: generate_user_configuration

TwoFactorAuth:: get_user_configuration

TwoFactorAuth:: remove_user_configuration

TwoFactorAuth:: set_user_configuration

UserManager

UserManager:: check_account_conflicts

UserManager:: create_user

UserManager:: delete_user

UserManager:: dismiss_merge

UserManager:: edit_user

UserManager:: list_users

UserManager:: lookup_service_account

UserManager:: lookup_user

UserManager:: merge_service_account

UserManager:: unlink_service_account

UserTasks

UserTasks:: delete

UserTasks:: retrieve

Variables

Variables:: get_server_information

Variables:: get_session_information

Variables:: get_user_information

VersionControl

VersionControl:: create

VersionControl:: delete

VersionControl:: retrieve

VersionControl:: update

VersionControlDeployment

VersionControlDeployment:: create

VersionControlDeployment:: delete

VersionControlDeployment:: retrieve

WebDisk

WebDisk:: delete_user

WebDisk:: set_homedir

WebDisk:: set_password

WebDisk:: set_permissions

WebmailApps

WebmailApps:: listwebmailapps

WebVhosts

WebVhosts:: list_domains

WebVhosts:: list_ssl_capable_domains

WordPressBackup

WordPressBackup:: any_running

WordPressBackup:: cancel

WordPressBackup:: cleanup

WordPressBackup:: get_available_backups

WordPressBackup:: is_running

WordPressBackup:: start

WordPressInstanceManager

WordPressInstanceManager:: cancel_scan

WordPressInstanceManager:: cleanup_scan

WordPressInstanceManager:: change_admin_password

WordPressInstanceManager:: configure_autoupdate

WordPressInstanceManager:: get_api_version

WordPressInstanceManager:: get_instance_by_id

WordPressInstanceManager:: get_instances

WordPressInstanceManager:: get_latest_wordpress_version_from_wordpress_org

WordPressInstanceManager:: get_scan_results

WordPressInstanceManager:: is_installable_addon_available

WordPressInstanceManager:: start_scan

WordPressRestore

WordPressRestore:: any_running

WordPressRestore:: cleanup

WordPressRestore:: start

Description

This function lists the cPanel account's Subaccounts.

Examples

cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/UserManager/list_users

Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation.

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// List the cPanel account's Subaccounts.
$UserManager = $cpanel->uapi(
    'UserManager', 'list_users',
	array(
		'flat'	=>	'0'
	)
);

Note:

For more information, read our Guide to the LiveAPI System.

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# List the cPanel account's Subaccounts.
my $UserManager = $cpliveapi->uapi(
    'UserManager', 'list_users',
	{	
	'flat'	=>	'0'
	}
);

Note:

For more information, read our Guide to the LiveAPI System.

Command Line

uapi --user=username UserManager list_users

Notes:

You must URI-encode values.
username represents your account-level username.
For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command.
If you run CloudLinux™, you must use the full path of the uapi command:
```
/usr/local/cpanel/bin/uapi
```

Output (JSON)

{
	"errors": null,
	"metadata": {
		"transformed": 1
	},
	"status": 1,
	"warnings": null,
	"messages": null,
	"data": [{
		"special": 0,
		"domain": "example.com",
		"parent_type": null,
		"services": {
			"webdisk": {
				"enabled": 0
			},
			"ftp": {
				"enabled": 1,
				"quota": "4444.00",
				"homedir": "public_html/example.com/ftp4"
			},
			"email": {}
		},
		"issues": [],
		"synced_password": 0,
		"has_invite": 0,
		"real_name": null,
		"phone_number": null,
		"can_set_password": 1,
		"dismissed": 0,
		"alternate_email": null,
		"guid": "FTP4:EXAMPLE.COM:5EDFA1D5:2E8C7512F20C3C2B2E6E8DCC7E1A353A2673A4B227004DBAEC4769A9D1267499",
		"merge_candidates": [],
		"has_siblings": 0,
		"sub_account_exists": 0,
		"has_expired_invite": 0,
		"full_username": "ftp4@example.com",
		"can_delete": 1,
		"username": "ftp4",
		"invite_expiration": null,
		"dismissed_merge_candidates": [],
		"can_set_quota": 1,
		"avatar_url": null,
		"type": "service"
	}, {
		"parent_type": null,
		"issues": [],
		"services": {
			"email": {},
			"ftp": {
				"homedir": "public_html/addonexample1.com/test1",
				"quota": "1111.00",
				"enabled": 1
			},
			"webdisk": {
				"enabled": 0
			}
		},
		"special": 0,
		"domain": "addonexample1.com",
		"has_invite": 0,
		"synced_password": 0,
		"dismissed": 0,
		"can_set_password": 1,
		"guid": "TEST1:ADDONEXAMPLE1.COM:5EDFA1D5:13A7CBEFACF36695A90226ECEDBFB54339D63A917DD0AC0CA5C95B866817CDE9",
		"merge_candidates": [],
		"alternate_email": null,
		"real_name": null,
		"phone_number": null,
		"has_expired_invite": 0,
		"full_username": "test1@addonexample1.com",
		"sub_account_exists": 0,
		"has_siblings": 0,
		"can_set_quota": 1,
		"type": "service",
		"avatar_url": null,
		"can_delete": 1,
		"username": "test1",
		"invite_expiration": null,
		"dismissed_merge_candidates": []
	}, {
		"synced_password": 0,
		"has_invite": 0,
		"special": 0,
		"domain": "example.com",
		"parent_type": null,
		"services": {
			"email": {
				"quota": 0,
				"enabled": 1
			},
			"ftp": {
				"enabled": 0
			},
			"webdisk": {
				"enabled": 0
			}
		},
		"issues": [],
		"real_name": null,
		"phone_number": null,
		"alternate_email": null,
		"guid": "EXAMPLE:EXAMPLE.COM:5EDFA1D5:63993460A6ECC7DBC92E611DA136B99E9AE3CB01D3C573A1A49E5CC9B1849E9A",
		"merge_candidates": [],
		"can_set_password": 1,
		"dismissed": 0,
		"has_siblings": 0,
		"sub_account_exists": 0,
		"full_username": "example@example.com",
		"has_expired_invite": 0,
		"invite_expiration": null,
		"dismissed_merge_candidates": [],
		"can_delete": 1,
		"username": "example",
		"avatar_url": null,
		"type": "service",
		"can_set_quota": 1
	}, {
		"full_username": "ftp1@example.com",
		"has_expired_invite": 0,
		"sub_account_exists": 0,
		"has_siblings": 0,
		"type": "service",
		"avatar_url": null,
		"can_set_quota": 1,
		"invite_expiration": null,
		"dismissed_merge_candidates": [],
		"can_delete": 1,
		"username": "ftp1",
		"has_invite": 0,
		"synced_password": 0,
		"parent_type": null,
		"services": {
			"ftp": {
				"enabled": 1,
				"quota": "0.00",
				"homedir": "public_html/example.com/ftp1"
			},
			"email": {},
			"webdisk": {
				"enabled": 0
			}
		},
		"issues": [],
		"special": 0,
		"domain": "example.com",
		"guid": "FTP1:EXAMPLE.COM:5EDFA1D5:7DAB3B3C8621CF939CC87817FC422E47FC3696C66120E8C6E302D05DB1134AF4",
		"merge_candidates": [],
		"alternate_email": null,
		"dismissed": 0,
		"can_set_password": 1,
		"real_name": null,
		"phone_number": null
	}, {
		"special": 0,
		"domain": "addonexample1.com",
		"parent_type": null,
		"services": {
			"ftp": {
				"quota": "3000.00",
				"homedir": "public_html/addonexample1.com/test3",
				"enabled": 1
			},
			"email": {},
			"webdisk": {
				"enabled": 0
			}
		},
		"issues": [],
		"synced_password": 0,
		"has_invite": 0,
		"can_set_password": 1,
		"dismissed": 0,
		"alternate_email": null,
		"guid": "TEST3:ADDONEXAMPLE1.COM:5EDFA1D5:B0C7D6D87C9EDC898ACF44709586E384FD08E8586F0791F2BCC94BBAB8578BF7",
		"merge_candidates": [],
		"real_name": null,
		"phone_number": null,
		"has_expired_invite": 0,
		"full_username": "test3@addonexample1.com",
		"has_siblings": 0,
		"sub_account_exists": 0,
		"can_set_quota": 1,
		"avatar_url": null,
		"type": "service",
		"can_delete": 1,
		"username": "test3",
		"invite_expiration": null,
		"dismissed_merge_candidates": []
	}, {
		"can_set_password": 1,
		"dismissed": 0,
		"alternate_email": null,
		"guid": "FTP2:EXAMPLE.COM:5EDFA1D5:EB29F27D7C6F0D8F062B91FBD3142E2F0FEA64CE8277BF51D1D4EDA9EC6FAF2E",
		"merge_candidates": [],
		"real_name": null,
		"phone_number": null,
		"special": 0,
		"domain": "example.com",
		"parent_type": null,
		"issues": [],
		"services": {
			"webdisk": {
				"enabled": 0
			},
			"ftp": {
				"homedir": "public_html/example.com/ftp2",
				"quota": "2000.00",
				"enabled": 1
			},
			"email": {}
		},
		"synced_password": 0,
		"has_invite": 0,
		"can_set_quota": 1,
		"avatar_url": null,
		"type": "service",
		"can_delete": 1,
		"username": "ftp2",
		"invite_expiration": null,
		"dismissed_merge_candidates": [],
		"has_expired_invite": 0,
		"full_username": "ftp2@example.com",
		"sub_account_exists": 0,
		"has_siblings": 0
	}, {
		"can_set_password": 1,
		"dismissed": 0,
		"alternate_email": null,
		"guid": "TEST1:EXAMPLE.COM:5EDFA1D5:65DAE1A7C0486B2CC77136666ACCD626388B49CE057178D31CBC6431883E2F6F",
		"merge_candidates": [],
		"phone_number": null,
		"real_name": null,
		"special": 0,
		"domain": "example.com",
		"parent_type": null,
		"services": {
			"ftp": {
				"enabled": 0
			},
			"email": {
				"enabled": 1,
				"quota": 0
			},
			"webdisk": {
				"enabled": 0
			}
		},
		"issues": [],
		"synced_password": 0,
		"has_invite": 0,
		"can_set_quota": 1,
		"avatar_url": null,
		"type": "service",
		"can_delete": 1,
		"username": "test1",
		"invite_expiration": null,
		"dismissed_merge_candidates": [],
		"has_expired_invite": 0,
		"full_username": "test1@example.com",
		"has_siblings": 0,
		"sub_account_exists": 0
	}, {
		"username": "boo",
		"can_delete": 1,
		"dismissed_merge_candidates": [],
		"invite_expiration": null,
		"can_set_quota": 1,
		"avatar_url": null,
		"type": "service",
		"sub_account_exists": 0,
		"has_siblings": 0,
		"has_expired_invite": 0,
		"full_username": "boo@example.com",
		"real_name": null,
		"phone_number": null,
		"can_set_password": 1,
		"dismissed": 0,
		"alternate_email": null,
		"merge_candidates": [],
		"guid": "BOO:EXAMPLE.COM:5EDFA1D5:84A67954C14780EC6FC5803B18E435CAA8DC4F9731D30DE93E66F017257512F7",
		"domain": "example.com",
		"special": 0,
		"services": {
			"email": {
				"quota": 0,
				"enabled": 1
			},
			"ftp": {
				"enabled": 0
			},
			"webdisk": {
				"enabled": 0
			}
		},
		"issues": [],
		"parent_type": null,
		"synced_password": 0,
		"has_invite": 0
	}, {
		"sub_account_exists": 0,
		"has_siblings": 0,
		"has_expired_invite": 0,
		"full_username": "username@example.com",
		"can_delete": 1,
		"username": "username",
		"invite_expiration": null,
		"dismissed_merge_candidates": [],
		"can_set_quota": 1,
		"avatar_url": null,
		"type": "service",
		"special": 0,
		"domain": "example.com",
		"parent_type": null,
		"services": {
			"webdisk": {
				"enabled": 0
			},
			"ftp": {
				"enabled": 0
			},
			"email": {
				"quota": 1024,
				"enabled": 1
			}
		},
		"issues": [],
		"synced_password": 0,
		"has_invite": 0,
		"real_name": null,
		"phone_number": null,
		"can_set_password": 1,
		"dismissed": 0,
		"alternate_email": null,
		"guid": "USERNAME:EXAMPLE.COM:5EDFA1D5:4476EF234E770B1EF77D79943FAA5CF0A2509BC2CB63EF1D7D1403E1DF1A4D57",
		"merge_candidates": []
	}, {
		"dismissed": 0,
		"can_set_password": 0,
		"guid": "EXAMPLE_LOGS::5EDFA1D5:190B224D094A76691A9504373B7898A2071983EEEF42C91EB4F96C86EC3E0BE8",
		"merge_candidates": [],
		"alternate_email": null,
		"real_name": null,
		"phone_number": null,
		"parent_type": null,
		"services": {
			"webdisk": {
				"enabled": 0
			},
			"email": {},
			"ftp": {
				"quota": "0.00",
				"homedir": "etc/apache2/logs/domlogs/example",
				"enabled": 1
			}
		},
		"issues": [],
		"special": 1,
		"domain": null,
		"has_invite": 0,
		"synced_password": 0,
		"can_set_quota": 0,
		"type": "service",
		"avatar_url": null,
		"can_delete": 0,
		"username": "example_logs",
		"invite_expiration": null,
		"dismissed_merge_candidates": [],
		"has_expired_invite": 0,
		"full_username": "example_logs",
		"sub_account_exists": 0,
		"has_siblings": 0
	}, {
		"alternate_email": null,
		"merge_candidates": [],
		"guid": "FREDDY:EXAMPLE.COM:5EDFA1D5:FE984E5CD5825D8C8300BC72E61B86539CB0BC0E384C60A5FCFE2FAEBED2DA67",
		"can_set_password": 1,
		"dismissed": 0,
		"phone_number": null,
		"real_name": null,
		"synced_password": 0,
		"has_invite": 0,
		"domain": "example.com",
		"special": 0,
		"services": {
			"webdisk": {
				"enabled": 0
			},
			"email": {
				"quota": 1024,
				"enabled": 1
			},
			"ftp": {
				"enabled": 0
			}
		},
		"issues": [],
		"parent_type": null,
		"avatar_url": null,
		"type": "service",
		"can_set_quota": 1,
		"dismissed_merge_candidates": [],
		"invite_expiration": null,
		"username": "freddy",
		"can_delete": 1,
		"full_username": "freddy@example.com",
		"has_expired_invite": 0,
		"sub_account_exists": 0,
		"has_siblings": 0
	}, {
		"dismissed_merge_candidates": [],
		"invite_expiration": null,
		"username": "example",
		"can_delete": 0,
		"type": "cpanel",
		"avatar_url": null,
		"can_set_quota": 0,
		"has_siblings": 0,
		"sub_account_exists": 0,
		"full_username": "example",
		"has_expired_invite": 0,
		"phone_number": null,
		"real_name": null,
		"merge_candidates": [],
		"guid": "EXAMPLE::5EDFA1D5:01CA544F123B9502C60B3F0AE0DD47BD89440F8CB18D1850BA1D792032DA8B17",
		"alternate_email": null,
		"dismissed": 0,
		"can_set_password": 0,
		"has_invite": 0,
		"synced_password": 0,
		"services": {
			"webdisk": {
				"enabled": 1
			},
			"email": {
				"enabled": 1
			},
			"ftp": {
				"enabled": 1
			}
		},
		"issues": [],
		"parent_type": null,
		"domain": null,
		"special": 1
	}]
}

Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

Parameter Type Description Possible values Example

flat

Boolean

Whether to return Subaccounts with the same name under the merge_candidates array.

This parameter defaults to 0.

1 — Do not return.
0 — Return.

0

Returns

Return	Type	Description	Possible values	Example
`alternate_email`	string	An alternate email address for the subaccount's user.	A valid email address.	`user@example.com`
`avatar_url`	string	The user's subaccount profile photo.	A valid HTTPS URL that points to an image file.	Click to view... `https://img.example.com/avatars/example.jpg`
`can_delete`	Boolean	Whether the cPanel account user can delete the subaccount.	`1` — Can delete. `0` — Cannot delete.	`0`
`can_set_password`	Boolean	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.	`1`
`can_set_quota`	Boolean	Whether the cPanel account user can change the subaccount's disk usage quota.	`1` — Can change. `0` — Cannot change.	`0`
`dismissed`	Boolean	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.	`1`
`domain`	string	The subaccount user's associated domain.	A domain that the cPanel account owns.	`example.com`
`full_username`	string	The subaccount's username and domain name.	A valid username, the `@` character, and the associated domain.	`user@example.com`
`guid`	string	The subaccount unique identifier.	The system assigned unique value.	Click to view... `N4641:EXAMPLE.COM:564CC8A7:A82EA007D8348AC631C0170F9418EC1DEB0D164CC5A722A87C55EF5DD2AD98D4`
`issues`	array of hashes	Information about any issues or problems with the subaccount.	This array of hashes contains the `type`, `area`, `service`, `message`, `used`, and `limit` returns.
`type`	string	The type of issue. The function returns this value in the `issues` array of hashes.	`error` `warning` `info`	`info`
`area`	string	The affected section of cPanel & WHM. The function returns this value in the `issues` array of hashes.	A valid section name.	`quota`
`service`	string	The affected service. The function returns this value in the `issues` array of hashes.	`email` `ftp` `webdisk`	`email`
`message`	string	The description of the issue. The function returns this value in the `issues` array of hashes.	A valid string.	`Your account is over quota.`
`used`	integer	The number of megabytes (MB) that the account currently uses. The function returns this value in the `issues` array of hashes.	A positive integer.	`2000`
`limit`	integer	The set quota megabyte (MB) limit for the affected subaccount. The function returns this value in the `issues` array of hashes.	A positive integer.	`1500`
`merge_candidates`	array of hashes	An array of hashes that represents the service accounts that the system could merge for this subaccount.	This array contains the `alternate_email`, `avatar_url`, `can_delete`, `can_set_password`, `can_set_quota`, `dismissed`, `domain`, `full_username`, `guid`, `has_siblings`, `issues`, `merge_candidates`, `parent_type`, `phone_number`, `real_name`, `services`, `special`, `sub_account_exists`, `synced_password`, `type`, and `username` returns.
`has_siblings`	Boolean	Whether the service account shares a `full_username` value with another service account.	`1` — Shares. `0` — Does not share.	`0`
`parent_type`	string	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.	hypothetical
`phone_number`	string	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.	`+15551234567`
`real_name`	string	The name of the subaccount's user.	A first name, a last name, or a first name and last name. An empty string.	`John Doe`
`services`	hash	This hash contains information about the subaccount's access to email, FTP, and Web Disk.	This hash contains the `email`, `ftp`, and `webdisk` returns.
`email`	hash	This hash contains the information that indicates the subaccount's email status. The function returns this hash in the `services` hash.	This hash contains the `enabled` and `quota` returns.
`enabled`	Boolean	Whether the subaccount can access Webmail, POP, and IMAP services. The function returns this value in the `email` hash.	`1` — Can access. `0` — Cannot access.	`1`
`quota`	integer	The maximum amount of disk space allocated to subaccount's email account. The function returns this value in the `email` hash.	A positive integer that represents the maximum disk space that the subaccount may use, in megabytes (MB). Note: In cPanel & WHM version 70 and later, this funciton will not return `0` as a value.	`100`
`ftp`	hash	This hash contains the information that indicates the subaccount's FTP status. The function returns this hash in the `services` hash.	This hash contains the `enabled`, `quota`, and `homedir` returns.
`enabled`	Boolean	Whether the subaccount can access FTP. The function returns this value in the `ftp` hash.	`1` — Can access. `0` — Cannot access.	`0`
`quota`	integer	The subaccount's FTP disk space quota. The function returns this value in the `ftp` hash.	A positive integer between `1` and `999999` that represents the maximum disk space that the subaccount may use, in megabytes (MB). `0` — Unlimited.	`100`
`homedir`	string	The subaccount's FTP home directory. The function returns this value in the `ftp` hash.	A valid path, relative to the cPanel account's home directory.	`/subaccount`
`webdisk`	hash	This hash contains information that indicates the subaccount's Web Disk status. The function returns this hash in the `services` hash.	This hash contains the `enabled`, `homedir`, `perms`, and `private` returns.
`enabled`	Boolean	Whether the subaccount can access Web Disk. The function returns this value in the `webdisk` hash.	`1` — Can access. `0` — Cannot access.	`0`
`homedir`	string	The subaccount's Web Disk home directory. The function returns this value in the `webdisk` hash.	A valid path, relative to the cPanel account's home directory.	`/bob`
`perms`	string	Whether to grant write permissions to the subaccount. The function returns this value in the `webdisk` hash.	`ro` — Read-only permissions. `rw` — Read and write permissions.	`rw`
`private`	Boolean	Whether to set the Web Disk directory's permissions to public or private. The function returns this value in the `webdisk` hash.	`1` — Private (`0700`). `0` — Public (`0755`).	`0`
`special`	Boolean	Whether the account is a system-created special account that the user cannot remove.	`1` — A special account. `0` — Not a special account.	`1`
`sub_account_exists`	Boolean	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.	`0`
`synced_password`	Boolean	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.	`0`
`type`	string	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.	`sub`
`username`	string	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.	`example`
`has_invite`	Boolean	Whether an account login invitation exists.	`1` — Account invitation exists. `0` — Account invitation does not exist.	`0`
`has_expired_invite`	Boolean	Whether an expired account login invitation exists.	`1` — Expired account invitation exists. `0` — Expired account invitation does not exist.	`0`
`invite_expiration`	integer	When the invitation expires.	A valid timestamp, in Unix epoch time.	`1591718154`
`dismissed_merge_candidates`	array of hashes	An array of hashes of service candidates that the system dismissed from merges.	This array contains the `alternate_email`, `avatar_url`, `can_delete`, `can_set_password`, `can_set_quota`, `dismissed`, `domain`, `full_username`, `guid`, `has_siblings`, `issues`, `merge_candidates`, `parent_type`, `phone_number`, `real_name`, `services`, `special`, `sub_account_exists`, `synced_password`, `type`, and `username` returns.

Function information

Module:

UserManager

API Version:

UAPI

Available in:

cPanel 54+

Methods:

GET, POST

Required Parameters:

(none)

Return formats:

JSON, XML

Legacy Equivalents:

(none)

About this module

The UserManager module modifies a cPanel account's Subaccounts.

About UAPI

UAPI accesses and modifies data for cPanel accounts.

Notes:

These functions may require specific features. To enable or disable features, use WHM's Feature Manager interface.
Unless you call this API via the WHM API, you must use the appropriate cPanel ports (2082 or 2083). You can also call some functions via cPanel's Webmail ports (2095 or 2096).

Find a function

Related functions

Page:

UAPI Functions - EmailAuth::get_mail_helo_ip — This function retrieves the HELO domain and IP address that the server uses when it sends a domain's mail.
Page:

UAPI Modules - DomainAliases — The DomainAliases module manages domain aliases.
Page:

UAPI Functions - DomainAliases::get_redirect_url — This function retrieves the redirection URL for a domain alias (parked domain).
Page:

UAPI Functions - DomainAliases::disable_redirect — This function disables the redirection URL for a domain alias (parked domain).
Page:

UAPI Functions - DomainAliases::set_redirect_url — This function redirects a domain alias (parked domain) to a URL.

Child pages

UAPI Functions - UserManager::list_users

Description

Examples

Parameters

Returns

Function information

About this module

About UAPI

Find a function

Search

Related functions