CPcpanel
Authentication
External Authentication

Disable identity provider

This function disables a external authentication identity provider for a specified service.

get/disable_authentication_provider

Request

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

Query parameters

provider_idstring required
Example:cpanelid

A valid identity provider's identification key.

service_name'cpaneld' | 'webmaild' | 'whostmgrd' required
Example:cpaneld

The cPanel & WHM service's name:

  • cpaneld
  • webmaild
  • whostmgrd

Response

HTTP Request was successful.

Example response

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

Changes

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