Get enabled identity providers
Retrieves the list of enabled identity providers. This endpoint accepts unauthenticated guest sessions, allowing the login screen to display the active identity provider entry points.
Required Permissions
You can call this endpoint without authentication, and no separate permission check is performed.
HTTP Request
GET /api/sonar/enabled-id-providers
cURL Example
curl https://HOSTNAME/api/sonar/enabled-id-providers
Request Parameters
| Key | Required | Type | Description | Notes |
|---|---|---|---|---|
| locale | No | String | Locale | - |
Success Response
{
"providers": [
{
"code": "saml",
"name": "SAML",
"path": "/sso/saml",
"icon": "iVBORw0KGgoAAAANSUhEUgAA..."
}
]
}
- providers (Array): List of enabled identity providers
- code (String): Identity provider code
- name (String): Localized display name
- path (String): SSO login entry path. This is a relative path based on the web console, not an absolute URL. It always follows the
/sso/<code>format - icon (String): Standard Base64-encoded icon image string. It does not have a
data:URI prefix.nullif no icon is set. The image format (MIME type) is not included in the response
The response has no field indicating the total count. Codes whose configuration is registered but whose identity provider app is not installed are silently excluded from the list.
Note
If the database is unavailable, such as during initialization, this is not treated as an error. The response returns HTTP status code 200 with an empty response body ({}).