Change passwords
Change the passwords of users in the native realm and built-in users.
Path parameters
-
The user whose password you want to change. If you do not specify this parameter, the password is changed for the current user.
Query parameters
-
refresh string
If
true
(the default) then refresh the affected shards to make this operation visible to search, ifwait_for
then wait for a refresh to make this operation visible to search, iffalse
then do nothing with refreshes.Values are
true
,false
, orwait_for
.
Body Required
-
password string
-
password_hash string
A hash of the new password value. This must be produced using the same hashing algorithm as has been configured for password storage. For more details, see the explanation of the
xpack.security.authc.password_hashing.algorithm
setting.
PUT /_security/user/{username}/_password
curl \
-X PUT http://api.example.com/_security/user/{username}/_password \
-H "Content-Type: application/json" \
-d '{"password":"string","password_hash":"string"}'
Request examples
{
"password": "string",
"password_hash": "string"
}
Response examples (200)
{}