パスワード変更API

ネイティブ領域および組み込みユーザーのパスワードを変更します。

リクエスト

POST /_security/user/_password

POST /_security/user/<username>/_password

前提条件

  • 各ユーザーは自分のパスワードを変更できます。manage_security 権限を持つユーザーは他のユーザーのパスワードを変更できます。

説明

ユーザー作成APIを使用して、ユーザーのusernameおよびpasswordを除くすべてを更新できます。このAPIはユーザーのパスワードを変更します。

ネイティブ領域に関する詳細は、領域およびネイティブユーザー認証を参照してください。

パスパラメータ

  • username
  • （オプション、文字列）パスワードを変更したいユーザー。 このパラメータを指定しない場合、パスワードは現在のユーザーのものが変更されます。

リクエストボディ

  • password
  • （文字列）新しいパスワードの値。 パスワードは最低6文字以上である必要があります。
    passwordまたはpassword_hashのいずれかが必要です。
  • password_hash
  • （文字列）新しいパスワードの値のハッシュ。 これは、パスワードストレージのために設定されたのと同じハッシュアルゴリズムを使用して生成する必要があります。 詳細については、ユーザーキャッシュとパスワードハッシュアルゴリズムのxpack.security.authc.password_hashing.algorithm設定の説明を参照してください。
    このパラメータを使用すると、クライアントはパフォーマンスおよび/または機密性の理由からパスワードを事前にハッシュ化できます。
    passwordパラメータとpassword_hashパラメータは同じリクエストで使用できません。

例

次の例は、jacknichユーザーのパスワードを更新します:

Python

  1. resp = client.security.change_password(
  2.    username="jacknich",
  3.    password="new-test-password",
  4. )
  5. print(resp)

Js

  1. const response = await client.security.changePassword({
  2.   username: "jacknich",
  3.   password: "new-test-password",
  4. });
  5. console.log(response);

コンソール

  1. POST /_security/user/jacknich/_password
  2. {
  3.   "password" : "new-test-password"
  4. }

成功した呼び出しは空のJSON構造を返します。

コンソール-結果

  1. {}