---
title: "Return available identity providers"
method: GET
path: "/get_available_authentication_providers"
tags: ["Authentication", "External Authentication"]
---

# Return available identity providers

`GET /get_available_authentication_providers`

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

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `providers` object[] — An array of available identity provider names and settings. Each hash in the array includes the cpaneld_link , whostmgrd_link , webmaild_link , icon , icon_type , provider_name , display_name , documentation_url , color , configured , id , label , textcolor , whostmgr_enabled , cpaneld_enabled , and webmaild_enabled returns.
      - `color` string — The background color of the button on the cPanel interface. A valid RGB hexadecimal color value.
      - `configured` 0 | 1 — Whether the identity provider is configured on the server. - 1 The provider is configured. - 0 The provider is not configured.
      - `cpaneld_enabled` 0 | 1 — Whether the identity provider is enabled for the cpaneld service. - 1 The provider is enabled for the cpaneld service.. - 0 The provider is not enabled for the cpaneld service.
      - `cpaneld_link` string — link to the identity provider's configuration for the cpaneld service on the system. A valid URL .
      - `display_name` string — The display name of the identity provider. A valid string.
      - `documentation_url` string — The URL to the identity provider's documentation. A valid URL.
      - `icon` string — The icon file to display in the button on the cPanel login interface. A valid Base64-encoded, JPG or PNG-formatted image file.
      - `icon_type` string — The icon file's MIME type. A valid image format's MIME type.
      - `id` string — The ID of the identity provider. A valid string.
      - `label` string — The text label that will appear on the cPanel login interface. A valid string.
      - `provider_name` string — The name of the identity provider. A valid string.
      - `textcolor` string — The color of the text label on the cPanel login interface. A valid RGB hexadecimal color value.
      - `webmaild_enabled` 0 | 1 — Whether the identity provider is enabled for the webmaild service. - 1 The provider is enabled for the webmaild service. - 0 The provider is not enabled for the webmaild service.
      - `webmaild_link` string — link to the identity provider's configuration for the webmaild service on the system. A valid URL .
      - `whostmgr_enabled` 0 | 1 — Whether the identity provider is enabled for the whostmgr service. - 1 The provider is enabled for the whostmgr service. - 0 The provider is not enabled for the whostmgr service.
      - `whostmgrd_link` string — link to the identity provider's configuration for the whostmgrd service on the system. A valid URL.
  - `metadata` object
    - `command` string — The method name called.
    - `reason` string — The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.
    - `result` 0 | 1 — * `1` - Success * `0` - Failed: Check the reason field for more details.
    - `version` integer — The version of the API function.

---

[API](https://skmtc.net/cpanel/apis/whm-api.md) · [All operations](https://skmtc.net/cpanel/apis/whm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/whm-api/revisions/3da41671c02c/schema)