- 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 disables a external authentication identity provider for a specified service.
Examples
https://hostname.example.com:2087/cpsess##########/json-api/disable_authentication_provider?api.version=1&provider_id=cpanelid&service_name=cpaneld
https://hostname.example.com:2087/cpsess##########/xml-api/disable_authentication_provider?api.version=1&provider_id=cpanelid&service_name=cpaneld
whmapi1 disable_authentication_provider provider_id=cpanelid service_name=cpaneld
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, "command": "disable_authentication_provider" } }
<result> <data/> <metadata> <version>1</version> <reason>OK</reason> <result>1</result> <command>disable_authentication_provider</command> </metadata> </result>
Note:
Parameters
Parameter | Type | Description | Possible values | Example |
---|---|---|---|---|
service_name | string | Required The cPanel & WHM service's name. | A valid service name:
| cpaneld |
provider_id | string | Required The identity provider's key. | A valid identity provider's key. | cpanelid |
Returns
This function only returns metadata.
Function information
API Version:
Available in:
WHM 54+
Methods:
GET, POST
Required Parameters:
provider_id
, service_name
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:Manage External Authentications — The Manage External Authentications interface allows you to manage your server's OpenID Connect-compliant identity providers.
-
Page:WHM API 1 Functions - list_configclusterservers — This function lists the servers in the server's configuration cluster.
-
Page:WHM API 1 Functions - update_configclusterserver — This function updates the username or remote access key for a cluster server.
-
Page:WHM API 1 Functions - delete_configclusterserver — This function removes a server from a configuration cluster.
-
Page:WHM API 1 Functions - add_configclusterserver — This function adds a server to a configuration cluster.