confirmForgotPassword method

Future<void> confirmForgotPassword({ required String clientId, required String confirmationCode, required String password, required String username, AnalyticsMetadataType? analyticsMetadata, Map<String, String>? clientMetadata, String? secretHash, UserContextDataType? userContextData, })

Allows a user to enter a confirmation code to reset a forgotten password.

May throw ResourceNotFoundException. May throw UnexpectedLambdaException. May throw UserLambdaValidationException. May throw InvalidParameterException. May throw InvalidPasswordException. May throw NotAuthorizedException. May throw CodeMismatchException. May throw ExpiredCodeException. May throw TooManyFailedAttemptsException. May throw InvalidLambdaResponseException. May throw TooManyRequestsException. May throw LimitExceededException. May throw UserNotFoundException. May throw UserNotConfirmedException. May throw InternalErrorException.

Parameter clientId : The app client ID of the app associated with the user pool.

Parameter confirmationCode : The confirmation code sent by a user's request to retrieve a forgotten password. For more information, see ForgotPassword.

Parameter password : The password sent by a user's request to retrieve a forgotten password.

Parameter username : The user name of the user for whom you want to enter a code to retrieve a forgotten password.

Parameter analyticsMetadata : The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmForgotPassword calls.

Parameter clientMetadata : A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the ConfirmForgotPassword API action, Amazon Cognito invokes the function that is assigned to the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmForgotPassword request. In your function code in AWS Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

• Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.
• Amazon Cognito does not validate the ClientMetadata value.
• Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.

Parameter secretHash : A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

Parameter userContextData : Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

Implementation

Future<void> confirmForgotPassword({
  required String clientId,
  required String confirmationCode,
  required String password,
  required String username,
  AnalyticsMetadataType? analyticsMetadata,
  Map<String, String>? clientMetadata,
  String? secretHash,
  UserContextDataType? userContextData,
}) async {
  ArgumentError.checkNotNull(clientId, 'clientId');
  _s.validateStringLength(
    'clientId',
    clientId,
    1,
    128,
    isRequired: true,
  );
  ArgumentError.checkNotNull(confirmationCode, 'confirmationCode');
  _s.validateStringLength(
    'confirmationCode',
    confirmationCode,
    1,
    2048,
    isRequired: true,
  );
  ArgumentError.checkNotNull(password, 'password');
  _s.validateStringLength(
    'password',
    password,
    6,
    256,
    isRequired: true,
  );
  ArgumentError.checkNotNull(username, 'username');
  _s.validateStringLength(
    'username',
    username,
    1,
    128,
    isRequired: true,
  );
  _s.validateStringLength(
    'secretHash',
    secretHash,
    1,
    128,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AWSCognitoIdentityProviderService.ConfirmForgotPassword'
  };
  await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    signed: false,
    // TODO queryParams
    headers: headers,
    payload: {
      'ClientId': clientId,
      'ConfirmationCode': confirmationCode,
      'Password': password,
      'Username': username,
      if (analyticsMetadata != null) 'AnalyticsMetadata': analyticsMetadata,
      if (clientMetadata != null) 'ClientMetadata': clientMetadata,
      if (secretHash != null) 'SecretHash': secretHash,
      if (userContextData != null) 'UserContextData': userContextData,
    },
  );
}