- Created by Documentation, last modified on Apr 09, 2018
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
Description
This function retrieves the login URL for the cPanel Store or a cPanel Market provider.
Examples
https://hostname.example.com:2087/cpsess##########/json-api/get_login_url?api.version=1&url_after_login=http%3A%2F%2Fhostname.example.com%2Fredirectionlocation.cgi%3Fstate&provider=cPStore
https://hostname.example.com:2087/cpsess##########/xml-api/get_login_url?api.version=1&url_after_login=http%3A%2F%2Fhostname.example.com%2Fredirectionlocation.cgi%3Fstate&provider=cPStore
whmapi1 get_login_url url_after_login=http:\/\/hostname.example.com\/redirectionlocation.cgi?state provider=cPStore
Notes:
- 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
{ "metadata": { "version": 1, "reason": "OK", "result": 1, "data": { "payload": "https://account.cpanel.net/oauth2/auth/login?client_id=d5eff4a09e29d5b20752674c0ab2c799c428eb23df4db2df10a5c9d96c37472c76013a41e9a0c714e852965ceaed2e8e05e2f738bc27ee562cfb683fbfc75a01&email=&redirect_uri=http%3A%2F%2Fhostname.example.com%2Fredirectionlocation.cgi%3Fstate&response_type=token" }, "command": "get_login_url" } }
<result> <metadata> <version>1</version> <reason>OK</reason> <result>1</result> <data> <payload>https://account.cpanel.net/oauth2/auth/login?client_id=d5eff4a09e29d5b20752674c0ab2c799c428eb23df4db2df10a5c9d96c37472c76013a41e9a0c714e852965ceaed2e8e05e2f738bc27ee562cfb683fbfc75a01&email=&redirect_uri=http%3A%2F%2Fhostname.example.com%2Fredirectionlocation.cgi%3Fstate&response_type=token</payload> </data> <command>get_login_url</command> </metadata> </result>
Note:
Parameters
Parameter | Type | Description | Possible values | Example |
---|---|---|---|---|
provider | string | Required The cPanel Store or cPanel Market provider's name. |
| cPStore |
url_after_login | string | Required The location to which the cPanel Store or cPanel Market provider redirects the user's browser after they log in. | Any valid URL that includes a query component. | http://hostname.example.com/redirectionlocation.cgi?state |
Return
Return | Type | Description | Possible values | Example |
---|---|---|---|---|
payload | string | The URL to which to redirect the browser after login. | A valid URL. | Click to view... https://account.cpanel.net/oauth2/auth/login?client_id=d5eff4a09e29d5b20752674c0ab2c799c428eb23df4db2df10a5c9d96c37472c76013a41e9a0c714e852965ceaed2e8e05e2f738bc27ee562cfb683fbfc75a01&email=&redirect_uri=http%3A%2F%2Fhostname.example.com%2Fredirectionlocation.cgi%3Fstate&response_type=token |
Function information
API Version:
Available in:
WHM 62+
Methods:
GET, POST
Required Parameters:
(none)
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 - get_login_url — This function retrieves the login URL for the cPanel Store or a cPanel Market provider.
-
Page:WHM API 1 Functions - validate_login_token — This function validates a login token with the cPanel Store or a cPanel Market provider, and then returns access tokens.
-
Page:WHM API 1 Functions - purchase_a_license — This function returns the checkout URL to use for a cPanel Store or cPanel Market provider purchase.
-
Page:WHM API 1 Functions - run_cpkeyclt — This function verifies the system's license status with cPanel, Inc.'s licensing servers.
-
Page:WHM API 1 Functions - accept_eula — This function records acceptance of cPanel & WHM's legal terms.