Update identity provider login interface appearance

This function sets the display configuration for the login button of an external authentication identity provider.

SecurityBasicAuth
Request
query Parameters
required
object

The display configuration in JSON-encoded key-value format.

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_display_configurations
Request samples
whmapi1 --output=jsonpretty set_provider_display_configurations service_name='cpaneld' provider_id='cpanelid' configurations='{"color":"dd4b39","display_name":"cPanel","icon":"iVBORw0KGgoAAAANSUhEUgAAACEAAAAhCAYAAABX5MJvAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAV1JREFUeNrsVtGNwjAMJegGYIRucBmhtwEjdAMyQjYoG2SEG6HcBGUDugFskHOQg1zTlFaN\\/\\/KkqMh2yYvt53S3KygomIZaE+y9P8BDJ9xXpdSDxT9jwX7dxDJsDMvCuvl33GF1sBwS5O8GX7eVgCabGyRkGJF25v0sJHrcyDH7iMhWEl9zWSD1\\/xs1klJn8J\\/gZ4WxNdgu8KyiDXGIfmJ7LO6R8CI5rJnwO+Kv0Wb9Z7xlZr+wMt8f\\/ANmyCoCMF3CUmP8rOmHip1AM\\/8tdbLcjfnL5NigYmIp+ilp5iYRJNkmajtLIBuJiUZ1S+aDKGDjI8tGk+N\\/9yuy0ODcGIjL8UEmcXKLDelRDQ5tHcuIkSLQE1WYhIRfMRIEmiV1Z7NES5Rh9nIisRGVWGOyyyflC5fSkDsTmk1KnVBMbForqQw+IVtUCP3KEpdojffHnRGKcq3LZ3pBgST+BRgANXt+WPKE7tYAAAAASUVORK5CYII=","icon_type":"image/svg+xml","label":"Log in with a cPanelID Account","textcolor":"FFFFFF"}'
Response samples
application/json
{
  • "metadata": {
    • "command": "set_provider_display_configurations",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}