latestOpenAPI 3.0.2cPanel License2026-08-106251554.3 MB

3da41671c02c

Authentication
External Authentication

Return identity provider client configuration

This function retrieves the configuration details for the client of an external authentication identity provider.

get/get_provider_client_configurations

Query parameters

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

{
  "data": {
    "client_configurations": {
      "client_id": "1234567890",
      "client_secret": "victoria",
      "redirect_uris": [
        "https://hostname.example.com:2083/openid_connect_callback/cpanelid",
        "https://hostname.example.com:2087/openid_connect_callback/cpanelid",
        "https://hostname.example.com:2096/openid_connect_callback/cpanelid"
      ]
    }
  },
  "metadata": {
    "command": "get_provider_client_configurations",
    "reason": "OK",
    "result": 1,
    "version": 1
  }
}