ユーザー一括削除

指定したユーザーを削除します。

必要な権限

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

HTTPリクエスト

cURL例

curl -H "Authorization: Bearer <API_KEY>" \
     -X DELETE \
     "https://HOSTNAME/api/sonar/users?guids=6ba6031e-9d03-4a2b-8372-20ceee8f2a76"

リクエストパラメータ

正常応答

{
  "failures": []
}

エラー応答

必須パラメータが欠落している場合

HTTPステータスコード 400 のレスポンス

{
  "error_code": "null-argument",
  "error_msg": "guids should be not null"
}

ユーザー識別子がGUID形式でない場合

HTTPステータスコード 400 のレスポンス

{
  "error_code": "invalid-param-type",
  "error_msg": "guids should be guid type."
}

上位権限のユーザー削除を試みた場合

HTTPステータスコード 200 のレスポンス

{
  "failures": [
    {
      "guid": "ffaf431b-653a-4329-8f83-913cbb00342d",
      "login": "gildong",
      "name": "홍길동",
      "reason": "no-permission"
    }
  ]
}

自分自身の削除を試みた場合

HTTPステータスコード 200 のレスポンス

{
  "failures": [
    {
      "guid": "ffaf431b-653a-4329-8f83-913cbb00342d",
      "login": "gildong",
      "name": "홍길동",
      "reason": "cannnot-remove-yourself"
    }
  ]
}

ユーザーが存在しない場合

HTTPステータスコード 200 のレスポンス。クラスター管理者以外のセッションで他のテナント（会社）のユーザーを削除しようとした場合も、検索失敗として処理されます。

{
  "failures": [
    {
      "guid": "6ba6031e-9d03-4a2b-8372-20ceee8f2a75",
      "reason": "user-not-found"
    }
  ]
}