ロール削除API

ネイティブ領域のロールを削除します。

リクエスト

DELETE /_security/role/<name>

前提条件

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

説明

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

パスパラメータ

  • name
  • (文字列) ロールの名前。

以下の例は、my_admin_roleロールを削除します:

Python

  1. resp = client.security.delete_role(
  2. name="my_admin_role",
  3. )
  4. print(resp)

Js

  1. const response = await client.security.deleteRole({
  2. name: "my_admin_role",
  3. });
  4. console.log(response);

コンソール

  1. DELETE /_security/role/my_admin_role

ロールが正常に削除されると、リクエストは{"found": true}を返します。そうでない場合、foundはfalseに設定されます。

コンソール-結果

  1. {
  2. "found" : true
  3. }