IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Create or update users API Delete roles API »

› › ›

Delete role mappings API

edit

Delete role mappings API

edit

Removes role mappings.

Request

edit

DELETE /_xpack/security/role_mapping/<name>

Description

edit

Role 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

edit

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

Examples

edit

The 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
}

« Create or update users API Delete roles API »