New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Delete role mappings API Delete users API »
Elastic Docs ›Elasticsearch Guide [7.1] ›X-Pack APIs ›Security APIs

Delete roles API

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Delete roles API

edit

Removes roles in the native realm.

Request

edit

DELETE /_security/role/<name>

Description

edit

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 Realms and Configuring a native realm.

Path Parameters

edit
name
(string) The name of the role.

Authorization

edit

To use this API, you must have at least the manage_security cluster privilege.

Examples

edit

The following example deletes a my_admin_role role:

DELETE /_security/role/my_admin_role
Copy as curlTry in Elastic 

If the role is successfully deleted, the request returns {"found": true}. Otherwise, found is set to false.

{
  "found" : true
}
« Delete role mappings API Delete users API »
Was this helpful?
Feedback