WARNING: Version 6.2 of Elasticsearch has passed its EOL date.

This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« Authenticate API Clear Cache API »
Elastic Docs ›Elasticsearch Reference [6.2] ›X-Pack APIs ›Security APIs

Change Password API

Change Password API

The Change Password API enables you to submit a request to change the password of a user.

Request

POST _xpack/security/user/_password

POST _xpack/security/user/<username>/_password

Path Parameters

username
(string) The user whose password you want to change. If you do not specify this parameter, the password is changed for the current user.

Request Body

password (required)
(string) The new password value.

Authorization

Every user can change their own password. Users with the manage_security privilege can change passwords of other users.

Examples

The following example updates the password for the elastic user:

POST _xpack/security/user/elastic/_password
{
  "password": "x-pack-test-password"
}

A successful call returns an empty JSON structure.

{}
« Authenticate API Clear Cache API »