ユーザーグループ一覧取得

検索条件に一致するユーザーグループの一覧を取得します。

必要な権限

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

HTTPリクエスト

GET /api/sonar/user-groups
cURL例
curl -H "Authorization: Bearer <API_KEY>" \
     https://HOSTNAME/api/sonar/user-groups
リクエストパラメータ
キー必須型説明備考
offset×32ビット整数スキップする件数デフォルトは0
limit×32ビット整数最大取得件数未指定時は全件取得
keywords×文字列検索キーワードname, descriptionを対象に検索
company_guid×文字列会社GUIDクラスター管理者アカウントのみ有効
guids×文字列リストユーザーグループGUIDリスト複数指定時はカンマ（,）区切り

正常応答

{
  "total_count": 1,
  "user_groups": [
    {
      "company_guid": "6fbe27b7-f1ae-4d7a-a1a5-76d8fa9aa311",
      "company_name": "Logpresso",
      "guid": "28c1251b-2f7c-4c58-95a1-fc4a1ead877e",
      "name": "Cyber Security",
      "description": "",
      "owner_guid": "ffaf431b-653a-4329-8f83-913cbb00342d",
      "owner_name": "Yang",
      "created": "2022-09-01 01:08:00+0900",
      "updated": "2022-09-01 01:08:00+0900"
    }
  ]
}
  • total_count（32ビット整数）：検索条件に一致する総件数
  • user_groups（配列）：ユーザーグループ一覧
    • company_guid（文字列）：会社（テナント）の識別子
    • company_name（文字列）：会社（テナント）の名称
    • guid（文字列）：ユーザーグループの識別子
    • name（文字列）：ユーザーグループの名称
    • description（文字列）：説明
    • owner_guid（文字列）：ユーザーグループ作成者のアカウント識別子
    • owner_name（文字列）：ユーザーグループ作成者のアカウント名
    • created（文字列）：作成日時。yyyy-MM-dd HH:mm:ssZ形式。
    • updated（文字列）：更新日時。yyyy-MM-dd HH:mm:ssZ形式。

エラー応答

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."
}