Disable users API

Disable users API

Disables users in the native realm.

Request

PUT /_security/user/<username>/_disable

Prerequisites

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

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

Path parameters

username

(Required, string) An identifier for the user.

Examples

The following example disables the user jacknich:

  1. PUT /_security/user/jacknich/_disable