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 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

username (required)
(string) An identifier for the user.

Authorization

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

Examples

The following example disables the user jacknich:

PUT /_xpack/security/user/jacknich/_disable