updatePassword method

Future<UpdatePasswordResult> updatePassword({
  1. required String oldPassword,
  2. required String newPassword,
  3. UpdatePasswordOptions? options,
})

Update the password of the current user.

NOTE: There must be a user signed in to perform this action.

Optionally accepts plugin options which allow customizing provider-specific behavior, e.g. the Cognito User Pool.

For more information, see the Amplify docs.

Examples

import 'package:amplify_auth_cognito/amplify_auth_cognito.dart';
import 'package:amplify_flutter/amplify_flutter.dart';
Future<void> updatePassword({
  required String oldPassword,
  required String newPassword,
}) async {
  try {
    await Amplify.Auth.updatePassword(
      oldPassword: oldPassword,
      newPassword: newPassword,
    );
  } on AmplifyException catch (e) {
    safePrint('Error updating password: ${e.message}');
  }
}

Implementation

Future<UpdatePasswordResult> updatePassword({
  required String oldPassword,
  required String newPassword,
  UpdatePasswordOptions? options,
}) => identifyCall(
  AuthCategoryMethod.updatePassword,
  () => defaultPlugin.updatePassword(
    oldPassword: oldPassword,
    newPassword: newPassword,
    options: options,
  ),
);