IDプロバイダタイプ設定仕様照会

指定したIDプロバイダタイプが定義している設定項目のメタデータを取得します。新しいSSO設定を作成または修正する際に、入力フォームを構成するための情報を提供します。

必要な権限

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

HTTPリクエスト

cURL例

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

リクエストパラメータ

正常応答

{
  "configs": [
    {
      "name": "identifier",
      "display_name": "Identifier",
      "description": "Account match identifier (login or email)",
      "type": "string",
      "subtype": null,
      "required": true,
      "protected": false,
      "default_value": null,
      "min": null,
      "max": null
    },
    {
      "name": "create_user",
      "display_name": "Create user",
      "description": "Automatically create a account if there is no matching account",
      "type": "boolean",
      "subtype": null,
      "required": true,
      "protected": false,
      "default_value": null,
      "min": null,
      "max": null
    },
    {
      "name": "idp_url",
      "display_name": "IdP URL",
      "description": "SAML IdPエンドポイント",
      "type": "string",
      "subtype": null,
      "required": true,
      "protected": false,
      "default_value": null,
      "min": null,
      "max": null
    },
    {
      "name": "client_secret",
      "display_name": "クライアントシークレット",
      "description": "",
      "type": "string",
      "subtype": null,
      "required": true,
      "protected": true,
      "default_value": null,
      "min": null,
      "max": null
    }
  ]
}

• configs (配列): 設定仕様一覧
  • name (文字列): 設定キー
  • display_name (文字列): ロケールが適用された画面表示名
  • description (文字列): ロケールが適用された画面表示説明
  • type (文字列): データ型。string、integer、boolean のいずれか
  • subtype (文字列): UIで認識される拡張コンポーネントタイプ。指定されていない場合は null
  • required (ブーリアン): 必須かどうか
  • protected (ブーリアン): 保護設定かどうか。パスワードのように照会時に露出してはならない項目は true
  • default_value (文字列): デフォルト値。subtype が enum の場合は null
  • selectable (文字列): 選択可能な値の一覧。subtype が enum の場合にのみ含まれます
  • min (数値): 最小値の制約。制約がない場合は null
  • max (数値): 最大値の制約。制約がない場合は null

設定項目一覧の先頭には、IDプロバイダタイプに関係なくソナーが共通で追加する必須項目が2つ並びます。この2項目はいずれも必須項目のため、subtype、default_value、min、max はすべて null です。また、この2項目の display_name と description には日本語が用意されていないため、locale に ja を指定しても英語の値が返されます。

• identifier: アカウント照合に使用する識別子。login または email として解釈され、値が指定されていない場合は email とみなされます
• create_user: 一致するアカウントがない場合にアカウントを自動作成するかどうか

共通項目の後には、該当IDプロバイダタイプが定義している設定項目が続きます。このエンドポイントは設定項目の定義のみを返し、保存された値は含みません。保存された値を併せて確認するにはIDプロバイダ照会を使用してください。

エラー応答

IDプロバイダタイプが存在しない場合

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

{
  "error_code": "invalid-argument",
  "error_msg": "provider not found: saml"
}

権限がない場合

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

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

IDプロバイダタイプの照会は権限検査より先に実行されるため、SSO閲覧権限がないアカウントでも登録されていないコードを要求すると、権限エラーではなく provider not found エラーを先に受け取ります。