CPcpanel
Authentication
Authentication Providers

Unregister cPanel account from authentication provider

This function unlinks a cPanel account from an external authentication identity provider.

get/unlink_user_authn_provider

Request

  • Base URL
    https://whm-server.tld:2087/json-api
  • Auth
    HTTP basic

Query parameters

provider_idstring required
Example:cpanelid

The system's internal key for the identity provider.

subject_unique_identifierstring required
Example:123456789012345678901

The unique identifier for the user at the identity provider.

usernamestring required
Example:example

The account's username.

Response

HTTP Request was successful.

Example response

{
  "metadata": {
    "command": "unlink_user_authn_provider",
    "reason": "OK",
    "result": 1,
    "version": 1
  }
}

Changes

No recorded changes to this operation across all 5 revisions of this API.