1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950 |
- [role="xpack"]
- [[security-api-delete-role-mapping]]
- === Delete role mappings API
- Removes role mappings.
- ==== Request
- `DELETE /_xpack/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 /_xpack/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
|