v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
ExternalAuthentication
External Authentication

Remove external authentication link

This function removes a link to an account at an external authentication identity provider.

get/ExternalAuthentication/remove_authn_link

Query parameters

providerstring required
Example:cpanelid

The name of the identity provider.

subject_unique_identifierstring required
Example:123456789012345678901

The unique identifier for the user at the identity provider.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "remove_authn_link",
  "module": "ExternalAuthentication",
  "result": {
    "status": 1
  }
}