Authentication
External Authentication
Return identity provider configuration fields
This function retrieves the configuration fields for a external authentication identity provider.
get/get_provider_configuration_fields
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
- whostmgrd
- webmaild
Response
HTTP Request was successful.
Example response
{
"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
}
}