有効化されたIDプロバイダ照会

有効化されているIDプロバイダの一覧を取得します。認証されていないゲストセッションからも呼び出せるよう許可されており、ログイン画面で有効化されたIDプロバイダの入口を表示する際に使用します。

必要な権限

認証なしで呼び出すことができ、別途の権限検査も行いません。

HTTPリクエスト

cURL例

curl https://HOSTNAME/api/sonar/enabled-id-providers

リクエストパラメータ

正常応答

{
  "providers": [
    {
      "code": "saml",
      "name": "SAML",
      "path": "/sso/saml",
      "icon": "iVBORw0KGgoAAAANSUhEUgAA..."
    }
  ]
}

• providers (配列): 有効化されているIDプロバイダの一覧
  • code (文字列): IDプロバイダコード
  • name (文字列): ロケールが適用された表示名
  • path (文字列): SSOログイン入口パス。Webコンソールを基準とした相対パスであり、絶対URLではありません。常に /sso/<code> 形式です
  • icon (文字列): アイコン画像を標準Base64でエンコードした文字列。data: URIの接頭辞は付きません。アイコンがない場合は null で、画像形式(MIMEタイプ)は応答に含まれません

応答には全件数を示すフィールドはありません。設定は登録されているものの、該当IDプロバイダのアプリがインストールされていないコードは一覧から静かに除外されます。