54 lines
1.1 KiB
Plaintext
54 lines
1.1 KiB
Plaintext
|
[role="xpack"]
|
||
|
|
[[security-api-delete-role]]
|
||
|
|
=== Delete roles API
|
||
|
|
|
||
|
|
Removes roles in the native realm.
|
||
|
|
|
||
|
|
==== Request
|
||
|
|
|
||
|
|
`DELETE /_xpack/security/role/<name>`
|
||
|
|
|
||
|
|
|
||
|
|
==== Description
|
||
|
|
|
||
|
|
The Roles API is generally the preferred way to manage roles, rather than using
|
||
|
|
file-based role management. For more information about the native realm, see
|
||
|
|
{stack-ov}/realms.html[Realms] and <<configuring-native-realm>>.
|
||
|
|
|
||
|
|
|
||
|
|
==== Path Parameters
|
||
|
|
|
||
|
|
`name`::
|
||
|
|
(string) The name of the role.
|
||
|
|
|
||
|
|
//==== Request Body
|
||
|
|
|
||
|
|
==== Authorization
|
||
|
|
|
||
|
|
To use this API, you must have at least the `manage_security` cluster
|
||
|
|
privilege.
|
||
|
|
|
||
|
|
|
||
|
|
==== Examples
|
||
|
|
|
||
|
|
The following example deletes a `my_admin_role` role:
|
||
|
|
|
||
|
|
[source,js]
|
||
|
|
--------------------------------------------------
|
||
|
|
DELETE /_xpack/security/role/my_admin_role
|
||
|
|
--------------------------------------------------
|
||
|
|
// CONSOLE
|
||
|
|
// TEST[setup:admin_role]
|
||
|
|
|
||
|
|
If the role is successfully deleted, the request returns `{"found": true}`.
|
||
|
|
Otherwise, `found` is set to false.
|
||
|
|
|
||
|
|
[source,js]
|
||
|
|
--------------------------------------------------
|
||
|
|
{
|
||
|
|
"found" : true
|
||
|
|
}
|
||
|
|
--------------------------------------------------
|
||
|
|
// TESTRESPONSE
|
||
|
|
|