Return identity provider configuration fields

This function retrieves the configuration fields for a 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` `whostmgrd` `webmaild` Enum: "cpaneld" "whostmgrd" "webmaild" Example: service_name=cpaneld

Responses

200

HTTP Request was successful.

Response Schema: application/json

	object
	object

get/get_provider_configuration_fields

Request samples

whmapi1 --output=jsonpretty \
  get_provider_configuration_fields \
  service_name='cpaneld' \
  provider_id='cpanelid'

Response samples

application/json

{"data": {"configuration_fields": [{"description": "The Secret of the Client",
"display_order": 1,
"field_id": "client_secret",
"label": "Client Secret",
"value": null
},
{"description": "The ID of the Client.",
"display_order": 0,
"field_id": "client_id",
"label": "Client ID",
"value": null
}
]
},
"metadata": {"command": "get_provider_configuration_fields",
"reason": "OK",
"result": 1,
"version": 1
}
}