IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Delete roles APIedit
Removes roles in the native realm.
Requestedit
DELETE /_security/role/<name>
Descriptionedit
The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The delete roles API cannot remove roles that are defined in roles files.
Path Parametersedit
-
name - (string) The name of the role.
Authorizationedit
To use this API, you must have at least the manage_security cluster
privilege.
Examplesedit
The following example deletes a my_admin_role role:
DELETE /_security/role/my_admin_role
If the role is successfully deleted, the request returns {"found": true}.
Otherwise, found is set to false.
{
"found" : true
}