更改密码 API

编辑

更改本机领域和内置用户的密码。

请求

编辑

POST /_security/user/_password

POST /_security/user/<用户名>/_password

先决条件

编辑
  • 每个用户都可以更改自己的密码。拥有 manage_security 权限的用户可以更改其他用户的密码。

描述

编辑

您可以使用创建用户 API 来更新除用户的 usernamepassword 之外的所有内容。 此 API 更改用户的密码。

有关本机领域的更多信息,请参阅领域本机用户身份验证

路径参数

编辑
username
(可选,字符串)要更改密码的用户。 如果不指定此参数,则会更改当前用户的密码。

请求正文

编辑
password

(字符串)新的密码值。密码必须至少包含 6 个字符。

必须提供 passwordpassword_hash 中的一个。

password_hash

(字符串)新密码值的哈希值。 这必须使用与配置用于密码存储的相同哈希算法生成。 有关更多详细信息,请参阅 用户缓存和密码哈希算法xpack.security.authc.password_hashing.algorithm 设置的说明。

使用此参数允许客户端出于性能和/或保密原因预先哈希密码。

password 参数和 password_hash 参数不能在同一个请求中使用。

示例

编辑

以下示例更新了 jacknich 用户的密码

resp = client.security.change_password(
    username="jacknich",
    password="new-test-password",
)
print(resp)
const response = await client.security.changePassword({
  username: "jacknich",
  password: "new-test-password",
});
console.log(response);
POST /_security/user/jacknich/_password
{
  "password" : "new-test-password"
}

成功的调用返回一个空的 JSON 结构。

{}