Description

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

Examples


https://hostname.example.com:2087/cpsess##########/json-api/set_provider_display_configurations?api.version=1&provider_id=google&service_name=cpaneld&configurations=%7B"textcolor"%3A"FF9999"%7D
https://hostname.example.com:2087/cpsess##########/xml-api/set_provider_display_configurations?api.version=1&provider_id=google&service_name=cpaneld&configurations=%7B"textcolor"%3A"FF9999"%7D
whmapi1 set_provider_display_configurations provider_id=google service_name=cpaneld configurations={\"textcolor\":\"FF9999\"}

{
  "data": {},
  "metadata": {
    "reason": "OK",
    "version": 1,
    "result": 1,
    "command": "set_provider_display_configurations"
  }
}
<result>
    <metadata>
        <reason>OK</reason>
        <result>1</result>
        <version>1</version>
        <command>set_provider_display_configurations</command>
    </metadata>
    <data/>
</result>

   

Parameters

ParameterTypeDescriptionPossible valuesExample
service_namestring

Required

The cPanel & WHM service's name.

A valid service name:

    • cpaneld
    • whostmgrd
    • webmaild
cpaneld
provider_idstring

Required

The identity provider's key.

A valid identity provider's key.

cpanelid
configurationsJSON

Required

The display configuration.

A JSON-encoded key-value set that includes display configuration settings, such as:

  • display_name
  • label
  • icon
  • textcolor
  • icon_type
  • color
{"textcolor":"FF9999"}


Returns

This function only returns metadata.