IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Delete users API Enable users API »
Elastic Docs ›Elasticsearch Guide [7.3] ›REST APIs ›Security APIs

Disable users API

edit

Disable users API

edit

Disables users in the native realm.

Request

edit

PUT /_security/user/<username>/_disable

Prerequisites

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

Description

edit

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

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

Examples

edit

The following example disables the user jacknich:

PUT /_security/user/jacknich/_disable
« Delete users API Enable users API »