Enable identity provider

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

SecurityBasicAuth
Request
query Parameters
provider_id
required
string

A valid identity provider's identification key.

Example: provider_id=cpanelid
service_name
required
string

The cPanel & WHM service's name:

  • cpaneld
  • webmaild
  • whostmgrd
Enum: "cpaneld" "webmaild" "whostmgrd"
Example: service_name=cpaneld
Responses
200

HTTP Request was successful.

Response Schema: application/json
object
get/enable_authentication_provider
Request samples
whmapi1 --output=jsonpretty \
  enable_authentication_provider \
  service_name='cpaneld' \
  provider_id='cpanelid'
Response samples
application/json
{
  • "metadata": {
    • "command": "enable_authentication_provider",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}