Update identity provider client configuration

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

SecurityBasicAuth
Request
query Parameters
configurations
required
string <json>

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.

Example: configurations={"client_id":"victoria","client_secret":"secret"}
provider_id
required
string

The identity provider's key.

Example: provider_id=cpanelid
service_name
required
string

The cPanel & WHM service's name.

  • cpaneld — The cPanel daemon.
  • whostmgrd — The WHM daemon.
  • webmaild — The Webmail daemon.
Enum: "cpaneld" "whostmgrd" "webmaild"
Example: service_name=cpaneld
Responses
200

HTTP Request was successful.

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