バルク削除ロールAPI（Bulk delete roles API）

バルク削除ロールAPI

この機能は技術プレビュー中であり、将来のリリースで変更または削除される可能性があります。Elasticは問題を修正するために取り組みますが、技術プレビューの機能は公式GA機能のサポートSLAの対象ではありません。

ネイティブ領域でのロールのバルク削除。

リクエスト

DELETE /_security/role/

前提条件

• このAPIを使用するには、少なくともmanage_securityクラスター権限を持っている必要があります。

説明

ロール管理APIは、ファイルベースのロール管理を使用するよりも、ロールを管理するための一般的に推奨される方法です。バルク削除ロールAPIは、ロールファイルで定義されたロールを削除することはできません。

パスパラメータ

• refresh
• 書き込みリクエストのリフレッシュポリシーのオプション設定。デフォルトは即時です。

リクエストボディ

次のパラメータは、DELETEリクエストのボディに指定でき、ロールのセットを削除することに関連しています：

• names
• (リスト) 削除するロール名のリスト。

例

次の例は、my_admin_roleおよびmy_user_roleロールを削除します：

Python

resp = client.security.bulk_delete_role(
   names=[
   "my_admin_role",
   "my_user_role"
   ],
)
print(resp)

Js

const response = await client.security.bulkDeleteRole({
  names: ["my_admin_role", "my_user_role"],
});
console.log(response);

コンソール

DELETE /_security/role
{
   "names": ["my_admin_role", "my_user_role"]
}

ロールが正常に削除された場合、リクエストは次のように返されます：

コンソール-結果

{
   "deleted": [
   "my_admin_role",
   "my_user_role"
   ]
}

ロールが見つからない場合、見つからないロールはnot_foundの下にグループ化されます：

Python

resp = client.security.bulk_delete_role(
   names=[
   "my_admin_role",
   "not_an_existing_role"
   ],
)
print(resp)

Js

const response = await client.security.bulkDeleteRole({
  names: ["my_admin_role", "not_an_existing_role"],
});
console.log(response);

コンソール

DELETE /_security/role
{
   "names": ["my_admin_role", "not_an_existing_role"]
}

コンソール-結果

{
   "deleted": [
   "my_admin_role"
   ],
   "not_found": [
   "not_an_existing_role"
   ]
}

リクエストが失敗したり無効な場合、エラーはerrorsの下にグループ化されます：

Python

resp = client.security.bulk_delete_role(
   names=[
   "my_admin_role",
   "superuser"
   ],
)
print(resp)

Js

const response = await client.security.bulkDeleteRole({
  names: ["my_admin_role", "superuser"],
});
console.log(response);

コンソール

DELETE /_security/role
{
   "names": ["my_admin_role", "superuser"]
}

コンソール-結果

{
   "deleted": [
   "my_admin_role"
   ],
   "errors": {
   "count": 1,
   "details": {
   "superuser": {
   "type": "illegal_argument_exception",
   "reason": "role [superuser] is reserved and cannot be deleted"
   }
   }
   }
}