Change passwords

POST also PUT /_security/user/{username}/_password
POST also PUT /_security/user/_password

Auth

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

Path parameters

username string optional

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

Leave it out to use /_security/user/_password.

Query parameters

refresh enum: 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.; Values: true false wait_for

Request body

password string: The new password value. Passwords must be at least 6 characters long.
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.

Response

application/json

Response Type: object

View as Markdown

Examples

Request Console 1 / 8 languages

Run POST /_security/user/jacknich/_password to update the password for the jacknich user.

Console Kibana Dev Tools

POST /_security/user/jacknich/_password
{
  "password" : "new-test-password"
}

JavaScript Elasticsearch JavaScript Client

const response = await client.security.changePassword({
  username: "jacknich",
  password: "new-test-password",
});

Python Elasticsearch Python Client

resp = client.security.change_password(
    username="jacknich",
    password="new-test-password",
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_security/user/jacknich/_password" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "password": "new-test-password"
  }'

Java Elasticsearch Java Client

client.security().changePassword(c -> c
    .password("new-test-password")
    .username("jacknich")
);

C# Elasticsearch .NET Client

var response = await client.Security
    .ChangePasswordAsync(d1 => d1
        .Username("jacknich")
        .Password("new-test-password")
    );

PHP Elasticsearch PHP Client

$resp = $client->security()->changePassword([
    "username" => "jacknich",
    "body" => [
        "password" => "new-test-password",
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.security.change_password(
  username: "jacknich",
  body: {
    "password": "new-test-password"
  }
)

Response

{}

Generated from the API spec

Path parameters

Query parameters

Request body { }

Response

Request body