Disable users APIedit

Disables users in the native realm.

Requestedit

PUT /_security/user/<username>/_disable

Prerequisitesedit

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

Descriptionedit

By 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 Native user authentication.

Path parametersedit

username
(Required, string) An identifier for the user.

Examplesedit

The following example disables the user jacknich:

PUT /_security/user/jacknich/_disable