---
title: "Return server's external authentication providers"
method: GET
path: "/ExternalAuthentication/configured_modules"
tags: ["ExternalAuthentication", "External Authentication"]
---

# Return server's external authentication providers

`GET /ExternalAuthentication/configured_modules`

This function lists the display information for your server's available and configured external authentication identity provider modules.

## Response `200`

HTTP Request was successful.

- object
  - `apiversion` integer — The version of the API.
  - `func` string — The name of the method called.
  - `module` string — The name of the module called.
  - `result` object
    - `data` object[]
      - `color` string, RGB — The background color of the button on the cPanel interface.
      - `display_name` string — The identity provider's friendly name. cPanel & WHM interfaces will display this value.
      - `documentation_url` string, url — The public URL of the identity provider's implementation documentation.
      - `icon` string, base64 image — The icon file to display on the button in the cPanel login interface.
      - `icon_type` string, MIME — The icon file's MIME type.
      - `label` string — The text label of the login icon in the cPanel login interface.
      - `link` string, url — link to the identity provider's configuration for the appropriate service on the system.
      - `provider_name` string — The identity provider's system name.
      - `textcolor` string, RGB — The color of the text label in the cPanel login interface.
    - `errors` string[], nullable — List of errors if the API failed.
    - `messages` string[], nullable — List of messages generated by the API.
    - `metadata` object
    - `status` 0 | 1 — - `1` - Success - `0` - Failed. Check the `errors` field for more details.
    - `warnings` string[], nullable — List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.

---

[API](https://skmtc.net/cpanel/apis/cpanel-uapi.md) · [All operations](https://skmtc.net/cpanel/apis/cpanel-uapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/cpanel-uapi/versions/632e2f8e6d04/schema)