インストール済みSSOプロバイダ照会

ソナーにインストールされているすべてのSSOプロバイダの一覧を取得します。有効/無効に関係なく、アプリとして登録されたプロバイダをすべて返すため、設定画面で新しいSSO設定を作成する際の候補一覧として使用します。

必要な権限

ADMIN以上のロールが必要です。

HTTPリクエスト

cURL例

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

正常応答

{
  "providers": [
    {
      "id": "saml",
      "name": "SAML",
      "path": "/sonar/sso/saml",
      "icon": "iVBORw0KGgoAAAANSUhEUgAA..."
    },
    {
      "id": "oidc",
      "name": "OpenID Connect",
      "path": "/sonar/sso/oidc",
      "icon": null
    }
  ]
}

• providers (配列): インストールされたSSOプロバイダ一覧
  • id (文字列): SSOプロバイダ識別子
  • name (文字列): ロケールが適用された表示名
  • path (文字列): SSOログイン入口パス
  • icon (文字列): Base64エンコードされたアイコン画像。アイコンがない場合は null

エラー応答

権限がない場合

HTTPステータスコード 500 応答

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