删除角色 API

编辑

删除原生领域中的角色。

请求

编辑

DELETE /_security/role/<name>

先决条件

编辑
  • 要使用此 API,您必须至少拥有 manage_security 集群权限。

描述

编辑

角色管理 API 通常是管理角色的首选方法,而不是使用基于文件的角色管理。删除角色 API 不能删除在角色文件中定义的角色。

路径参数

编辑
name
(字符串) 角色的名称。

示例

编辑

以下示例删除名为 my_admin_role 的角色

resp = client.security.delete_role(
    name="my_admin_role",
)
print(resp)
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
}