$fn.changePassword(param)

アプリケーションの認証ユーザを更新します。[非同期] v3.3.0で追加された関数になります。

ノート

• 非同期関数であるため、コール時にawait式が必要になります。
• 外部認証ユーザを更新することはできません。

引数

名前	型	説明
param	object	更新するユーザ情報

param詳細

プロパティ	型	説明
email	string	Eメール
currentPassword	string	現在のパスワード
newPassword	string	新しいパスワード

ノート

本関数によるパスワード変更が可能な条件は、ステータスが CONFIRMED ユーザのみとなります。
また、実行可能回数は1時間当たりに５回までとなります。

戻り値

型	説明
Promise<User>	更新したユーザ情報

オブジェクト	プロパティ	型	説明
User	userId	string	ユーザID (GUID)
	email	string	Eメール
	name	string	名前
	custom_01	string	カスタム属性1
	custom_02	string	カスタム属性2
	custom_03	string	カスタム属性3
	custom_04	string	カスタム属性4
	custom_05	string	カスタム属性5
	custom_06	string	カスタム属性6
	custom_07	string	カスタム属性7
	custom_08	string	カスタム属性8
	custom_09	string	カスタム属性9
	custom_10	string	カスタム属性10
	enabled	boolean	有効/無効
	created	string	作成日時
	updated	string	更新日時
	status	string	ユーザのステータス

サンプル

try {
  await $fn.changePassword({
    email: $param.email,
    currentPassword: $param.currentPassword,
    newPassword: $param.newPassword
  });

} catch (err) {
  console.log("Error",err)
}