12345678910111213141516171819202122232425262728293031323334353637383940414243 |
- [role="xpack"]
- [[security-api-disable-user]]
- === Disable users API
- Disables users in the native realm.
- ==== Request
- `PUT /_xpack/security/user/<username>/_disable`
- ==== Description
- By default, when you create users, they are enabled. You can use this API to
- revoke a user's access to {es}. To re-enable a user, there is an
- <<security-api-enable-user,enable users API>>.
- For more information about the native realm, see
- {stack-ov}/realms.html[Realms] and <<configuring-native-realm>>.
- ==== Path Parameters
- `username` (required)::
- (string) An identifier for the user.
- //==== Request Body
- ==== Authorization
- To use this API, you must have at least the `manage_security` cluster privilege.
- ==== Examples
- The following example disables the user `jacknich`:
- [source,js]
- --------------------------------------------------
- PUT /_xpack/security/user/jacknich/_disable
- --------------------------------------------------
- // CONSOLE
- // TEST[setup:jacknich_user]
|