$fn.changePassword(param)

Updates the authentication user of the application. [asynchronous]
v3.3.0 This is a built-in function added.

Note

• Since this is an asynchronous function, an await expression is required when calling it.
• External authentication users cannot be updated.

Arguments

Name	Type	Description
param	object	User information to update

param Details

Property	Type	Description
email	string	Email
currentPassword	string	Current password
newPassword	string	New password

Note

Password changes using this function are only possible for users with CONFIRMED status.
Additionally, the maximum number of executions is five times per hour.

Return Value

Type	Description
Promise<User>	Updated user information

Object	Property	Type	Description
User	userId	string	User ID (GUID)
	email	string	Email
	name	string	Name
	custom_01	string	Custom attribute 1
	custom_02	string	Custom attribute 2
	custom_03	string	Custom attribute 3
	custom_04	string	Custom attribute 4
	custom_05	string	Custom attribute 5
	custom_06	string	Custom attribute 6
	custom_07	string	Custom attribute 7
	custom_08	string	Custom attribute 8
	custom_09	string	Custom attribute 9
	custom_10	string	Custom attribute 10
	enabled	boolean	Enabled/Disabled
	created	string	Created date and time
	updated	string	Updated date and time
	status	string	User status

Sample

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

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