ロール削除API
ネイティブ領域のロールを削除します。
リクエスト
DELETE /_security/role/<name>
前提条件
- このAPIを使用するには、少なくとも
manage_security
クラスター権限を持っている必要があります。
説明
ロール管理APIは、ファイルベースのロール管理を使用するよりも、一般的にロールを管理するための推奨方法です。削除ロールAPIは、ロールファイルに定義されたロールを削除することはできません。
パスパラメータ
name
- (文字列) ロールの名前。
例
以下の例は、my_admin_role
ロールを削除します:
Python
resp = client.security.delete_role(
name="my_admin_role",
)
print(resp)
Js
const response = await client.security.deleteRole({
name: "my_admin_role",
});
console.log(response);
コンソール
DELETE /_security/role/my_admin_role
ロールが正常に削除されると、リクエストは{"found": true}
を返します。そうでない場合、found
はfalseに設定されます。
コンソール-結果
{
"found" : true
}