latestOpenAPI 3.0.2cPanel License2026-08-106251554.3 MB

3da41671c02c

Authentication
External Authentication

Update identity provider client configuration

This function sets the values of configuration fields for an external authentication identity provider.

get/set_provider_client_configurations

Query parameters

configurationsstring json required
Example:{"client_id":"victoria","client_secret":"secret"}

The configuration values to set for the identity provider.

Note

The items in this parameter depend on the fields that the provider implements through OpenID.

provider_idstring required
Example:cpanelid

The identity provider's key.

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

The cPanel & WHM service's name.

  • cpaneld — The cPanel daemon.
  • whostmgrd — The WHM daemon.
  • webmaild — The Webmail daemon.

Response

HTTP Request was successful.

Example response

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