Return available identity providers

This function lists available external authentication identity providers for all services.

SecurityBasicAuth

Responses

200

HTTP Request was successful.

Response Schema: application/json

	object
	object

get/get_available_authentication_providers

Request samples

whmapi1 --output=jsonpretty \
  get_available_authentication_providers

Response samples

application/json

{"data": {"providers": [{"color": "dd4b39",
"configured": 1,
"cpaneld_enabled": 1,
"cpaneld_link": "https://hostname.example.com:2083/openid_connect/cpanelid",
"display_name": "cPanel",
"documentation_url": "https://go.cpanel.net/cpanelidmanage",
"icon": "Click to view...iVBORw0KGgoAAAANSUhEUgAAACEAAAAhCAYAAABX5MJvAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAV1JREFUeNrsVtGNwjAMJegGYIRucBmhtwEjdAMyQjYoG2SEG6HcBGUDugFskHOQg1zTlFaN\\/\\/KkqMh2yYvt53S3KygomIZaE+y9P8BDJ9xXpdSDxT9jwX7dxDJsDMvCuvl33GF1sBwS5O8GX7eVgCabGyRkGJF25v0sJHrcyDH7iMhWEl9zWSD1\\/xs1klJn8J\\/gZ4WxNdgu8KyiDXGIfmJ7LO6R8CI5rJnwO+Kv0Wb9Z7xlZr+wMt8f\\/ANmyCoCMF3CUmP8rOmHip1AM\\/8tdbLcjfnL5NigYmIp+ilp5iYRJNkmajtLIBuJiUZ1S+aDKGDjI8tGk+N\\/9yuy0ODcGIjL8UEmcXKLDelRDQ5tHcuIkSLQE1WYhIRfMRIEmiV1Z7NES5Rh9nIisRGVWGOyyyflC5fSkDsTmk1KnVBMbForqQw+IVtUCP3KEpdojffHnRGKcq3LZ3pBgST+BRgANXt+WPKE7tYAAAAASUVORK5CYII=",
"icon_type": "image/svg+xml",
"id": "cpanelid",
"label": "Log in with a cPanelID Account",
"provider_name": "cpanel",
"textcolor": "FFFFFF",
"webmaild_enabled": 1,
"webmaild_link": "https://hostname.example.com:2096/openid_connect/cpanelid",
"whostmgr_enabled": 1,
"whostmgrd_link": "https://hostname.example.com:2087/openid_connect/cpanelid"
}
]
},
"metadata": {"command": "get_available_authentication_providers",
"reason": "OK",
"result": 1,
"version": 1
}
}