confirmSignIn method

Future<SignInResult> confirmSignIn({
  1. required String confirmationValue,
  2. ConfirmSignInOptions? options,
})

Confirm the current sign in with the confirmationValue provided by the user.

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

Examples

For example, to confirm a sign in requring MFA:

import 'package:amplify_auth_cognito/amplify_auth_cognito.dart';
import 'package:amplify_flutter/amplify_flutter.dart';

Future<void> confirmMfaUser(String mfaCode) async {
  try {
    final result = await Amplify.Auth.confirmSignIn(
      confirmationValue: mfaCode,
    );
    return _handleSignInResult(result);
  } on AuthException catch (e) {
    safePrint('Error confirming MFA code: ${e.message}');
  }
}

Confirming a sign in can still require additional confirmations which should be handled accordingly.

Future<void> _handleSignInResult(SignInResult result) async {
  switch (result.nextStep.signInStep) {
    // ยทยทยท
  }
}

See signIn for examples of all confirmation flows.

Implementation

Future<SignInResult> confirmSignIn({
  required String confirmationValue,
  ConfirmSignInOptions? options,
}) =>
    identifyCall(
      AuthCategoryMethod.confirmSignIn,
      () => defaultPlugin.confirmSignIn(
        confirmationValue: confirmationValue,
        options: options,
      ),
    );