OpenSearch/x-pack/docs/en/rest-api/security/delete-role-mappings.asciidoc

54 lines
1.2 KiB
Plaintext
Raw Normal View History

[role="xpack"]
[[security-api-delete-role-mapping]]
=== Delete role mappings API
2018-12-20 13:23:28 -05:00
++++
<titleabbrev>Delete role mappings</titleabbrev>
++++
Removes role mappings.
==== Request
`DELETE /_security/role_mapping/<name>`
==== Description
Role mappings define which roles are assigned to each user. For more information,
see {stack-ov}/mapping-roles.html[Mapping users and groups to roles].
==== Path Parameters
`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.
//==== Request Body
==== Authorization
To use this API, you must have at least the `manage_security` cluster privilege.
==== Examples
The following example delete a role mapping:
[source,js]
--------------------------------------------------
DELETE /_security/role_mapping/mapping1
--------------------------------------------------
// CONSOLE
// TEST[setup:role_mapping]
If the mapping is successfully deleted, the request returns `{"found": true}`.
Otherwise, `found` is set to false.
[source,js]
--------------------------------------------------
{
"found" : true
}
--------------------------------------------------
// TESTRESPONSE