# cPanel Authentication API

**Canonical:** https://apis.io/apis/cpanel/cpanel-authentication-api/  
**Provider:** cPanel — https://apis.io/providers/cpanel/  
**Base URL:** https://{host}:2083/execute  
**Documentation:** https://api.docs.cpanel.net/cpanel/introduction/

cPanel Authentication API is one of 144 APIs that [cPanel](https://apis.io/providers/cpanel/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Authentication. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

The Authentication module for WHM API 1.

## Operations (31)

| Method | Path | Summary |
|---|---|---|
| GET | `/api_token_create` | Create WHM API token |
| GET | `/api_token_get_details` | Look up API token details |
| GET | `/api_token_list` | Return WHM API tokens |
| GET | `/api_token_revoke` | Disable WHM API token |
| GET | `/api_token_update` | Update WHM API token's settings |
| GET | `/disable_authentication_provider` | Disable identity provider |
| GET | `/disable_failing_authentication_providers` | Disable identity provider modules that fail to load |
| GET | `/enable_authentication_provider` | Enable identity provider |
| GET | `/get_available_authentication_providers` | Return available identity providers |
| GET | `/get_login_url` | Return cPanel Store or cPanel Market login URL |
| GET | `/get_provider_client_configurations` | Return identity provider client configuration |
| GET | `/get_provider_configuration_fields` | Return identity provider configuration fields |
| GET | `/get_provider_display_configurations` | Return identity provider login interface appearance |
| GET | `/get_users_authn_linked_accounts` | Return accounts linked to identity providers |
| GET | `/link_user_authn_provider` | Add identity provider to cPanel account |
| GET | `/set_provider_client_configurations` | Update identity provider client configuration |
| GET | `/set_provider_display_configurations` | Update identity provider login interface appearance |
| GET | `/twofactorauth_disable_policy` | Disable 2FA |
| GET | `/twofactorauth_enable_policy` | Enable 2FA |
| GET | `/twofactorauth_generate_tfa_config` | Create a one-time authentication secret and code |
| GET | `/twofactorauth_get_issuer` | Return configured issuer for current user |
| GET | `/twofactorauth_get_tfa_config_for_user` | Return cPanel account 2FA data |
| GET | `/twofactorauth_get_user_configs` | Return cPanel accounts with 2FA enabled |
| GET | `/twofactorauth_policy_status` | Return 2FA policy status |
| GET | `/twofactorauth_remove_user_config` | Remove 2FA settings |
| GET | `/twofactorauth_set_issuer` | Update 2FA issuer value |
| GET | `/twofactorauth_set_tfa_config` | Update 2FA authentication secret and code |
| POST | `/twofactorauth_set_tfa_config_for_user` | Update cPanel account's 2FA data |
| GET | `/unlink_user_authn_provider` | Unregister cPanel account from authentication provider |
| GET | `/validate_login_token` | Validate login token and return access token |
| GET | `/wp_dashboard_create_api_token` | Create API token for Dashboard |

## Machine-readable artifacts (7)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/cpanel/refs/heads/main/openapi/cpanel-authentication-api-openapi.yml
- **Documentation** — https://api.docs.cpanel.net/cpanel/introduction/
- **APIReference** — https://api.docs.cpanel.net/specifications/cpanel.openapi
- **Authentication** — https://api.docs.cpanel.net/cpanel/tokens/
- **Documentation** — https://api.docs.cpanel.net/whm/introduction/
- **APIReference** — https://api.docs.cpanel.net/specifications/whm.openapi
- **Authentication** — https://api.docs.cpanel.net/whm/tokens/

## Other cPanel APIs (12)

- [cPanel API 2 (Legacy)](https://apis.io/apis/cpanel/cpanel-api-2/)
- [Manage2 API](https://apis.io/apis/cpanel/manage2/)
- [cPanel 360 Monitoring API](https://apis.io/apis/cpanel/cpanel-360-monitoring-api/)
- [cPanel Account Creation API](https://apis.io/apis/cpanel/cpanel-account-creation-api/)
- [cPanel Account Enhancements API](https://apis.io/apis/cpanel/cpanel-account-enhancements-api/)
- [cPanel Account Management API](https://apis.io/apis/cpanel/cpanel-account-management-api/)
- [cPanel Account Restoration API](https://apis.io/apis/cpanel/cpanel-account-restoration-api/)
- [cPanel Accounts API](https://apis.io/apis/cpanel/cpanel-accounts-api/)
- [cPanel Addon Domain API](https://apis.io/apis/cpanel/cpanel-addondomain-api/)
- [cPanel API Execution API](https://apis.io/apis/cpanel/cpanel-api-execution-api/)
- [cPanel Applications API](https://apis.io/apis/cpanel/cpanel-applications-api/)
- [cPanel Backup API](https://apis.io/apis/cpanel/cpanel-backup-api/)

## Tags

Authentication

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/cpanel/cpanel-authentication-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/cpanel/.