---
title: "Return identity provider login interface appearance"
method: GET
path: "/get_provider_display_configurations"
tags: ["Authentication", "External Authentication"]
---

# Return identity provider login interface appearance

`GET /get_provider_display_configurations`

This function retrieves the display configuration for the login button of an external authentication identity provider.

## Query parameters

- `provider_id` string, required

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `configurations` object[] — An array of objects containing information about each service's external authentication display information.
      - `color` string, RGB — The background color of the button in the cPanel interface.
      - `display_name` string — The display name of the identity provider.
      - `documentation_url` string, url — The URL to the identity provider's documentation.
      - `icon` string, byte — The icon file in the button that the cPanel login interface displays.
      - `icon_type` string — The icon file's MIME type.
      - `label` string — The text label in the button that the cPanel login interface displays.
      - `link` string — A reference URL to the identity provider's configuration for the system.
      - `provider_name` string — The name of the identity provider.
      - `service` 'cpaneld' | 'whostmgrd' | 'webmaild' — The service's name. * `cpaneld` * `whostmgrd` * `webmaild`
      - `textcolor` string, RGB — The color of the text label in the button that the cPanel login interface displays.
  - `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` 1 | 0 — * `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)