IDプロバイダタイプ一覧照会

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

必要な権限

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

HTTPリクエスト

cURL例

curl -H "Authorization: Bearer <API_KEY>" \
     https://HOSTNAME/api/sonar/id-provider-factories

リクエストパラメータ

正常応答

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

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

一覧はデータベースに保存された設定ではなく、サーバに登録されているIDプロバイダタイプ全体を基準とします。応答には全件数を示すフィールドはありません。

エラー応答

権限がない場合

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

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