NOTE: You are looking at documentation for an older release. For the latest information, see the current release documentation.
Disable users API
editDisable users API
editDisables users in the native realm.
Request
editPUT /_xpack/security/user/<username>/_disable
Description
editBy default, when you create users, they are enabled. You can use this API to revoke a user’s access to Elasticsearch. To re-enable a user, there is an enable users API.
For more information about the native realm, see Realms and Configuring a native realm.
Path Parameters
edit-
username
(required) - (string) An identifier for the user.
Authorization
editTo use this API, you must have at least the manage_security
cluster privilege.
Examples
editThe following example disables the user jacknich
:
PUT /_xpack/security/user/jacknich/_disable