New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
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 [6.6] ›X-Pack APIs ›Security APIs

Disable users API

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Disable users API

edit

Disables users in the native realm.

Request

edit

PUT /_xpack/security/user/<username>/_disable

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.

Authorization

edit

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

Examples

edit

The following example disables the user jacknich:

PUT /_xpack/security/user/jacknich/_disable
Copy as curlTry in Elastic 
« Delete users API Enable users API »
Was this helpful?
Feedback