- Created by Documentation, last modified on Feb 11, 2019
disable_authentication_provider
disable_failing_authentication_providers
enable_authentication_provider
get_available_authentication_providers
get_provider_client_configurations
get_provider_configuration_fields
get_provider_display_configurations
get_users_authn_linked_accounts
set_provider_client_configurations
set_provider_display_configurations
twofactorauth_generate_tfa_config
twofactorauth_get_user_configs
cpgreylist_is_server_netblock_trusted
cpgreylist_list_entries_for_common_mail_provider
cpgreylist_load_common_mail_providers_config
cpgreylist_save_common_mail_providers_config
cpgreylist_trust_entries_for_common_mail_provider
cpgreylist_untrust_entries_for_common_mail_provider
create_cpgreylist_trusted_host
delete_cpgreylist_trusted_host
block_incoming_email_from_country
block_incoming_email_from_domain
expunge_messages_for_mailbox_guid
get_unique_recipient_count_per_sender_for_user
get_unique_sender_recipient_count_per_user
get_user_email_forward_destination
list_blocked_incoming_email_countries
list_blocked_incoming_email_domains
set_user_email_forward_destination
unblock_incoming_email_from_country
unblock_incoming_email_from_domain
Description
This function validates a system user for use on the target server.
Note:
For more information about how this function works with other functions in the transfer and restore process, read our Guide to Transfer and Restore API Functions documentation.
Examples
https://hostname.example.com:2087/cpsess##########/json-api/validate_system_user?api.version=1&user=username
https://hostname.example.com:2087/cpsess##########/xml-api/validate_system_user?api.version=1&user=username
whmapi1 validate_system_user user=username
Notes:
- Unless otherwise noted, you must URI-encode values.
- For more information and additional output options, read our Guide to WHM API 1 documentation or run the
whmapi1 --help
command. If you run CloudLinux™, you must use the full path of the
whmapi1
command:/usr/local/cpanel/bin/whmapi1
{ "data": { "valid_for_transfer": 1, "reserved": 1, "exists": 1, "valid_for_new": 1 }, "metadata": { "version": 1, "reason": "OK", "result": "1", "command": "validate_system_user" } }
<result> <data> <valid_for_transfer>1</valid_for_transfer> <reserved>1</reserved> <exists>1</exists> <valid_for_new>1</valid_for_new> </data> <metadata> <version>1</version> <reason>OK</reason> <result>1</result> <command>validate_system_user</command> </metadata> </result>
Note:
Parameters
Parameter | Type | Description | Possible values | Example |
---|---|---|---|---|
user | string | Required The system username. | A valid username. | username |
Returns
Return | Type | Description | Possible values | Example |
---|---|---|---|---|
| Boolean | Whether the username is valid for a transferred account, but not a new account. |
| 1 |
reserved | Boolean | Whether the username is reserved. |
| 1 |
exists | Boolean | Whether the username exists on the server. |
| 1 |
valid_for_new | Boolean | Whether the system can use the username to create a new account. |
| 1 |
Function information
API Version:
Available in:
WHM 11.44+
Methods:
GET, POST
Required Parameters:
user
Return Formats:
About WHM API 1
WHM API 1 performs functions and accesses data in WHM.
Notes:
- Some functions and parameters may require that you authenticate as the
root
user. - You must use the appropriate WHM ports (
2086
or2087
) to call WHM API functions.
Find a function
Related functions
-
Page:WHM API 1 Functions - abort_transfer_session — This function aborts an active transfer session.
-
Page:WHM API 1 Functions - analyze_transfer_session_remote — This function checks the remote server's credentials, which a transfer session uses to connect.
-
Page:WHM API 1 Functions - remote_basic_credential_check — This function checks the SSH credentials on the remote server.
-
Page:WHM API 1 Functions - restore_modules_summary — This function lists backup modules and their descriptions.
-
Page: