- Created by Documentation, last modified on Apr 09, 2018
Backup:: fullbackup_to_ftp
Backup:: fullbackup_to_homedir
Backup:: fullbackup_to_scp_with_key
Backup:: fullbackup_to_scp_with_password
Backup:: list_backups
Batch:: strict
Brand:: read
Branding:: file
Branding:: get_applications
Branding:: get_application_information
Branding:: get_available_applications
Branding:: get_information_for_applications
Branding:: image
Branding:: include
Branding:: spritelist
Chkservd:: get_exim_ports
Chkservd:: get_exim_ports_ssl
Chrome:: get_dom
Contactus:: is_enabled
cPGreyList:: disable_all_domains
cPGreyList:: disable_domains
cPGreyList:: enable_all_domains
cPGreyList:: enable_domains
cPGreyList:: has_greylisting_enabled
cPGreyList:: list_domains
DomainInfo:: domains_data
DomainInfo:: list_domains
DomainInfo:: main_domain_builtin_subdomain_aliases
DomainInfo:: single_domain_data
DNSSEC:: disable_dnssec
DNSSEC:: enable_dnssec
DNSSEC:: fetch_ds_records
DNSSEC:: set_nsec3
DNSSEC:: unset_nsec3
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:: 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_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_filter
Email:: unsuspend_incoming
Email:: unsuspend_login
Email:: unsuspend_outgoing
Email:: verify_password
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:: add_authn_link
ExternalAuthentication:: configured_modules
ExternalAuthentication:: get_authn_links
ExternalAuthentication:: has_external_auth_modules_configured
ExternalAuthentication:: remove_authn_link
Features:: has_feature
Features:: list_features
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:: 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
Integration:: fetch_url
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:: get_last_or_current_logged_in_ip
Locale:: get_attributes
Mailboxes:: expunge_mailbox_messages
Mailboxes:: expunge_messages_for_mailbox_guid
Mailboxes:: get_mailbox_status
Mailboxes:: has_utf8_mailbox_names
Mailboxes:: set_utf8_mailbox_names
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:: add_handler
Mime:: add_hotlink
Mime:: add_mime
Mime:: add_redirect
Mime:: delete_handler
Mime:: delete_hotlink
Mime:: delete_mime
Mime:: delete_redirect
Mime:: list_handlers
Mime:: list_hotlinks
Mime:: list_mime
Mime:: list_redirects
Mime:: redirect_info
ModSecurity:: disable_all_domains
ModSecurity:: disable_domains
ModSecurity:: enable_all_domains
ModSecurity:: enable_domains
ModSecurity:: has_modsecurity_installed
ModSecurity:: list_domains
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:: get_host_notes
Mysql:: get_privileges_on_database
Mysql:: get_restrictions
Mysql:: get_server_information
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
Notifications:: get_notifications_count
Parser:: firstfile_relative_uri
PassengerApps:: disable_application
PassengerApps:: edit_application
PassengerApps:: enable_application
PassengerApps:: list_applications
PassengerApps:: register_application
PassengerApps:: unregister_application
PasswdStrength:: get_required_strength
Postgresql:: create_database
Postgresql:: create_user
Postgresql:: delete_database
Postgresql:: get_restrictions
Postgresql:: grant_all_privileges
Postgresql:: rename_database
Postgresql:: rename_user
Postgresql:: rename_user_no_password
Postgresql:: revoke_all_privileges
Postgresql:: set_password
Pushbullet:: send_test_message
Quota:: get_quota_info
Resellers:: list_accounts
ResourceUsage:: get_usages
Session:: create_temp_user
SpamAssassin :: clear_spam_box
SpamAssassin:: get_symbolic_test_names
SpamAssassin:: get_user_preferences
SpamAssassin:: update_user_preference
SSH:: get_port
SSL:: add_autossl_excluded_domains
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_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:: upload_cert
SSL:: upload_key
StatsBar:: get_stats
SubDomain:: addsubdomain
TwoFactorAuth:: generate_user_configuration
TwoFactorAuth:: get_user_configuration
TwoFactorAuth:: remove_user_configuration
TwoFactorAuth:: set_user_configuration
UserManager:: check_account_conflicts
UserManager:: create_user
UserManager:: delete_user
UserManager:: dismiss_user
UserManager:: edit_user
UserManager:: list_users
UserManager:: lookup_service_account
UserManager:: lookup_user
UserManager:: merge_service_account
UserManager:: unlink_service_account
WebmailApps:: listwebmailapps
WebVhost:: list_domains
WebVhost:: list_ssl_capable_domains
WordPressBackup:: any_running
WordPressBackup:: cancel
WordPressBackup:: cleanup
WordPressBackup:: get_available_backups
WordPressBackup:: is_running
WordPressBackup:: start
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
Description
This function lists a single Subaccount's information.
Examples
https://hostname.example.com:2083/cpsess##########/execute/UserManager/lookup_user?guid=EXAMPLE1%3AEXAMPLE.COM%3A564CD663%3AFE50072F2620B50988EA4E5F46022546FBE6BDDE3C36C2F2534F4967C661EC37
Note:
This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation.
$cpanel = new CPANEL(); // Connect to cPanel - only do this once. // List a Subaccount. $UserManager = $cpanel->uapi( 'UserManager', 'lookup_user', array( 'guid' => 'EXAMPLE1%3AEXAMPLE.COM%3A564CD663%3AFE50072F2620B50988EA4E5F46022546FBE6BDDE3C36C2F2534F4967C661EC37' ) );
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once. # List a Subaccount. my $UserManager = $cpliveapi->uapi( 'UserManager', 'lookup_user', { 'guid' => 'EXAMPLE1%3AEXAMPLE.COM%3A564CD663%3AFE50072F2620B50988EA4E5F46022546FBE6BDDE3C36C2F2534F4967C661EC37' } );
<!-- List a Subaccount. --> [% execute('UserManager', 'lookup_user', {'guid' => 'EXAMPLE1%3AEXAMPLE.COM%3A564CD663%3AFE50072F2620B50988EA4E5F46022546FBE6BDDE3C36C2F2534F4967C661EC37',} ) %]
uapi --user=username UserManager lookup_user guid=EXAMPLE1%3AEXAMPLE.COM%3A564CD663%3AFE50072F2620B50988EA4E5F46022546FBE6BDDE3C36C2F2534F4967C661EC37
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
{ "data":{ "parent_type":null, "has_expired_invite":0, "type":"sub", "avatar_url":null, "can_set_quota":0, "dismissed":0, "guid":"EXAMPLE1:EXAMPLE.COM:577D1256:877AF09F728A672078D0733ADB9B715F544C722D152DF0C1A5DE5084BD972AF1", "domain":"example.com", "invite_expiration":1467987286, "synced_password":0, "merge_candidates":[ ], "sub_account_exists":0, "has_invite":1, "real_name":"Bob Doe", "username":"example1", "dismissed_merge_candidates":[ ], "special":0, "can_delete":1, "alternate_email":"robert@example1.com", "has_siblings":0, "services":{ "webdisk":{ "enabled":1, "private":0, "homedir":"home/example/public_html/webdav", "perms":"rw", "enabledigest":1 }, "email":{ "enabled":1, "quota":0 }, "ftp":{ "enabled":1, "quota":"42.00", "homedir":"example1@example.com" } }, "can_set_password":1, "issues":[ ], "phone_number":null, "full_username":"example1@example.com" }, "status":1, "messages":null, "errors":null, "metadata":{ } }
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 |
---|---|---|---|---|
guid | string | Required The Subaccount's unique identifier. | A system-assigned unique value.
| Click to view...
|
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...
|
can_delete | Boolean | Whether the cPanel account user can delete the subaccount. |
| 0 |
can_set_password | Boolean | Whether the cPanel account user can change the subaccount's password.
|
Note: The function returns a | 1 |
can_set_quota | Boolean | Whether the cPanel account user can change the subaccount's disk usage quota. |
| 0 |
dismissed | Boolean | Whether the cPanel account user dismissed the merge prompt for the service account. Note: Only service accounts return this value. |
| 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...
|
issues | array | Information about any issues or problems with the subaccount. | This array contains the | |
| string | The type of issue. The function returns this value in the |
| info |
| string | The affected section of cPanel & WHM. The function returns this value in the | A valid section name. | quota |
| string | The affected service. The function returns this value in the |
| email |
| string | The description of the issue. The function returns this value in the | A valid string. | Your account is over quota. |
| integer | The number of Megabytes (MB) that the account currently uses. The function returns this value in the | A positive integer. | 2000 |
| integer | The set quota Megabyte (MB) limit for the affected subaccount. The function returns this value in the | A positive integer. | 1500 |
merge_candidates | array | 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. |
| 0 |
parent_type | string | The type of account that could own the service account. |
| 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. |
| 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. | |
| hash | This hash contains the information that indicates the subaccount's email status. The function returns this hash in the | This hash contains the | |
| Boolean | Whether the subaccount can access Webmail, POP, and IMAP services. The function returns this value in the |
| 1 |
| integer | The maximum amount of disk space allocated to subaccount's email account. The function returns this value in the | 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 | 100 |
| hash | This hash contains the information that indicates the subaccount's FTP status. The function returns this hash in the | This hash contains the | |
| Boolean | Whether the subaccount can access FTP. The function returns this value in the |
| 0 |
| integer | The subaccount's FTP disk space quota. The function returns this value in the |
| 100 |
| string | The subaccount's FTP home directory. The function returns this value in the | A valid path, relative to the cPanel account's home directory. | /subaccount |
| hash | This hash contains information that indicates the subaccount's Web Disk status. The function returns this hash in the | This hash contains the | |
| Boolean | Whether the subaccount can access Web Disk. The function returns this value in the |
| 0 |
| string | The subaccount's Web Disk home directory. The function returns this value in the | A valid path, relative to the cPanel account's home directory. | /bob |
| string | Whether to grant write permissions to the subaccount. The function returns this value in the |
| rw |
| Boolean | Whether to set the Web Disk directory's permissions to public or private. The function returns this value in the |
| 0 |
special | Boolean | Whether the account is a system-created special account that the user cannot remove.
|
| 1 |
sub_account_exists | Boolean | Whether a subaccount exists with the same username. |
Note: The function returns a | 0 |
synced_password | Boolean | Whether the user has synchronized the passwords for each of the subaccount's service accounts. |
Note: The function returns a | 0 |
type | string | The type of account. |
| sub |
username | string | The username for the subaccount. | A username that meets the subaccount name limitations.
Note: This value does not include the domain name. | example |
Function information
Module:
UserManager
API Version:
Available in:
cPanel 54+
Methods:
GET, POST
Required Parameters:
guid
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
or2083
). You can also call some functions via cPanel's Webmail ports (2095
or2096
).
Find a function
Related functions
-
Page:cPanel API 1 Functions - Bandwidth::displaybwheader — This function generates a monthly bandwidth graph.
-
Page:cPanel API 1 Functions - Bandwidth::displayday — This function generates bandwidth graphs for the specified day.
-
Page:cPanel API 1 Functions - Bandwidth::displaymainbwheader — This function generates bandwidth graphs for the current day, week, and year.
-
Page:cPanel API 1 Functions - LastLogin::lastlogin — This function retrieves the IP address of the last user to successfully log in to the cPanel account.
-
Page:cPanel API 1 Functions - Email::addautoresponder — This function creates an autoresponder for an email account.