Return identity provider client configuration

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

SecurityBasicAuth
Request
query Parameters
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
object
get/get_provider_client_configurations
Request samples
whmapi1 --output=jsonpretty \
  get_provider_client_configurations \
  service_name='cpaneld' \
  provider_id='cpanelid'
Response samples
application/json
{}