Change passwords

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

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

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Path parameters

Query parameters

Request body

Response

application/json

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

No example

Authentication

Path parameters

Query parameters

Request body { }

Response

Request body