Search + K

Command Palette

Search for a command to run...

Sign In

Change passwords

PUT /_security/user/{username}/_password
Copy endpoint

Change the passwords of users in the native realm and built-in users.

Parameters

path Path Parameters

Name Type
username required

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

type TypesUsername = string

query Query Parameters

Name Type
refresh

If true (the default) then refresh the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false then do nothing with refreshes.

type TypesRefresh = "true" | "false" | "wait_for"

Request Body

application/json required
{ password?: TypesPassword
type TypesPassword = string
;password_hash?: string; }

Responses

200 application/json
{}