NOTE: You are looking at documentation for an older release. For the latest information, see the current release documentation.
Delete role mappings API
edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.
Delete role mappings API
editRemoves role mappings.
Request
editDELETE /_xpack/security/role_mapping/<name>
Description
editRole mappings define which roles are assigned to each user. For more information, see Mapping users and groups to roles.
Path Parameters
edit-
name - (string) The distinct name that identifies the role mapping. The name is used solely as an identifier to facilitate interaction via the API; it does not affect the behavior of the mapping in any way.
Authorization
editTo use this API, you must have at least the manage_security cluster privilege.
Examples
editThe following example delete a role mapping:
DELETE /_xpack/security/role_mapping/mapping1
If the mapping is successfully deleted, the request returns {"found": true}.
Otherwise, found is set to false.
{
"found" : true
}