Get SSO Providers

Retrieves SSO provider configurations matching the search criteria. The response includes operational details such as enabled state, description, and last updated time.

Required Permissions

Requires the ADMIN role or higher.

HTTP Request

cURL Example

curl -H "Authorization: Bearer <API_KEY>" \
     https://HOSTNAME/api/sonar/sso-providers

Request Parameters

Success Response

{
  "total_count": 1,
  "providers": [
    {
      "id": "saml",
      "name": "SAML",
      "path": "/sonar/sso/saml",
      "icon": "iVBORw0KGgoAAAANSUhEUgAA...",
      "enabled": true,
      "description": "Corporate SAML IdP integration",
      "updated": "2026-04-15T09:00:00+0900"
    }
  ]
}

• total_count (32-bit integer): Total number of records matching the criteria
• providers (Array): SSO provider configurations
  • id (String): SSO provider identifier
  • name (String): Localized display name
  • path (String): SSO login entry path
  • icon (String): Base64-encoded icon image, or null if no icon is provided
  • enabled (Boolean): Whether the provider is enabled
  • description (String): User-supplied description
  • updated (Timestamp): Last update time

Error Responses

offset or limit value is not an integer

HTTP status code 400

{
  "error_code": "invalid-argument",
  "error_msg": "'offset' parameter should be int type"
}

Permission denied

HTTP status code 500

{
  "error_code": "illegal-state",
  "error_msg": "no-permission"
}