updateUserPassword method

Future<MyUserEventsVersionedMixin?> updateUserPassword({
  1. MyUserIdentifier? identifier,
  2. UserPassword? newPassword,
  3. MyUserCredentials? confirmation,
})

Updates or resets password of the authenticated MyUser or the one identified by the provided MyUserIdentifier.

If the MyUser has no password yet, then the confirmation argument is not required. Otherwise, it's mandatory to authenticate this operation additionally by providing the confirmation argument.

This mutation can be used for both changing the MyUser's password and recovering it. Use the Mutation.createConfirmationCode to create a new ConfirmationCode for authenticating the password recovery, and provide it as the confirmation argument along with the identifier argument to this mutation.

If the concrete MyUserIdentifier.email address or MyUserIdentifier.phone number is provided, then the provided ConfirmationCode is validated against it exclusively, meaning that providing ConfirmationCodes sent to any other MyUserEmails.confirmed or MyUserPhones.confirmed is invalid. Otherwise, if a MyUserIdentifier.num or a MyUserIdentifier.login is provided, then a ConfirmationCode sent to any of MyUserEmails.confirmed or MyUserPhones.confirmed is suitable.

User-Agent HTTP header must be specified for this mutation and meet the UserAgent scalar format.

Authentication

Mandatory if the identifier argument is absent or null.

Result

Only the following MyUserEvent is always produced on success:

Non-idempotent

Each time renews the password (recalculates hash) even if it's the same one.

Additionally, always uses the provided ConfirmationCode, disallowing to use it again.

Implementation

Future<MyUserEventsVersionedMixin?> updateUserPassword({
  MyUserIdentifier? identifier,
  UserPassword? newPassword,
  MyUserCredentials? confirmation,
}) async {
  Log.debug('updateUserPassword(***, ***)', '$runtimeType');

  final variables = UpdateUserPasswordArguments(
    ident: identifier,
    password: newPassword,
    confirmation: confirmation,
  );
  QueryResult res = await client.mutate(
    MutationOptions(
      operationName: 'UpdateUserPassword',
      document: UpdateUserPasswordMutation(variables: variables).document,
      variables: variables.toJson(),
    ),
    onException:
        (data) => UpdateUserPasswordException(
          (UpdateUserPassword$Mutation.fromJson(data).updateUserPassword
                  as UpdateUserPassword$Mutation$UpdateUserPassword$UpdateUserPasswordError)
              .code,
        ),
    raw: RawClientOptions(token),
  );
  return UpdateUserPassword$Mutation.fromJson(res.data!).updateUserPassword
      as MyUserEventsVersionedMixin?;
}