接続プロファイル一覧取得

利用可能な接続プロファイルの一覧を取得します。

必要な権限

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

HTTPリクエスト

cURL例

curl -H "Authorization: Bearer <API_KEY>" \
     "https://HOSTNAME/api/sonar/connect-profiles?offset=0&limit=20"

リクエストパラメータ

正常応答

{
  "total_count": 1,
  "profiles": [
    {
      "guid": "b7f00412-8720-4a8f-ac35-7d7f359f797e",
      "code": "build",
      "name": "ビルドサーバSSH",
      "type": "ssh",
      "description": "",
      "configs": {
        "password": "",
        "port": 22,
        "host": "build",
        "server_alive_interval": null,
        "user": "logpresso",
        "timeout": 30
      },
      "config_description": "ホスト: build, ポート: 22, アカウント: gildong, 認証方式: パスワード, タイムアウト: 30秒",
      "factory_display_name": "SSH",
      "created": "2022-09-01 00:39:35+0900",
      "updated": "2022-09-01 00:39:35+0900",
      "grant_users": [
        {
          "type": "USER",
          "guid": "bfd00bb0-be99-4fd5-8380-166f544975fa",
          "name": "ホン・ギルドン",
          "read_only": true,
          "created": "2022-09-02 19:38:21+0900"
        }
      ],
      "grant_groups": [
        {
          "type": "USER",
          "guid": "28c1251b-2f7c-4c58-95a1-fc4a1ead877e",
          "name": "dev",
          "read_only": true,
          "created": "2022-09-02 19:38:21+0900"
        }
      ],
      "protected_keys": ["password"]
    }
  ]
}

• total_count (32ビット整数): 検索条件に一致する全接続プロファイル数
• profiles (配列): 検索条件に一致する接続プロファイルの一覧
  • guid (文字列): 接続プロファイルのユニーク識別子
  • code (文字列): クエリ用識別子。同一接続プロファイル種別内で一意の名称
  • name (文字列): 接続プロファイルの画面表示名
  • type (文字列): 接続プロファイル種別
  • description (文字列): 接続プロファイルの説明
  • configs (マップ): 接続プロファイルのキー/値ペア。passwordのような保護対象設定は、値を返さず空文字列で設定済みであることのみ返します。
  • config_description (文字列): 接続プロファイル設定の要約情報。リスト上で特定の接続プロファイルを識別できる主要情報を表示します。
  • factory_display_name (文字列): 接続プロファイル種別の画面表示名。例として、jdbc種別は「データベース」と返します。
  • created (文字列): 作成日時（yyyy-MM-dd HH:mm:ssZ形式）
  • updated (文字列): 更新日時（yyyy-MM-dd HH:mm:ssZ形式）
  • grant_users (配列): 接続プロファイルの利用権限が付与されたユーザー一覧
    • type (文字列): 共有オブジェクト種別。常にUSERで応答
    • guid (文字列): ユーザーのユニーク識別子
    • name (文字列): ユーザー氏名
    • read_only (ブール値): 編集可否。常にfalseで応答
    • created (文字列): 権限マッピング作成日時
  • grant_groups (配列): 接続プロファイルの利用権限が付与されたユーザーグループ一覧
    • type (文字列): 共有オブジェクト種別。常にUSERで応答
    • guid (文字列): ユーザーグループのユニーク識別子
    • name (文字列): ユーザーグループ名
    • read_only (ブール値): 編集可否。常にfalseで応答
    • created (文字列): 権限マッピング作成日時
  • protected_keys (配列): 保護されている設定キー名の一覧。例としてpassword設定は取得時に返されません。

エラー応答

offset、limitの値が整数でない場合

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

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

offset、limitの値が負の場合

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

{
  "error_code": "invalid-argument",
  "error_msg": "'offset' must be greater than or equal to 0."
}