latestOpenAPI 3.0.2cPanel License2026-08-106251554.3 MB

3da41671c02c

Authentication
External Authentication

Enable identity provider

This function enables an external authentication identity provider for a specified service.

get/enable_authentication_provider

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": "enable_authentication_provider",
    "reason": "OK",
    "result": 1,
    "version": 1
  }
}