forgotPassword method

Future<ForgotPasswordResponse> forgotPassword({ required String clientId, required String username, AnalyticsMetadataType? analyticsMetadata, Map<String, String>? clientMetadata, String? secretHash, UserContextDataType? userContextData, })

Calling this API causes a message to be sent to the end user with a confirmation code that is required to change the user's password. For the Username parameter, you can use the username or user alias. The method used to send the confirmation code is sent according to the specified AccountRecoverySetting. For more information, see Recovering User Accounts in the Amazon Cognito Developer Guide. If neither a verified phone number nor a verified email exists, an InvalidParameterException is thrown. To use the confirmation code for resetting the password, call ConfirmForgotPassword.

May throw ResourceNotFoundException. May throw InvalidParameterException. May throw UnexpectedLambdaException. May throw UserLambdaValidationException. May throw NotAuthorizedException. May throw InvalidLambdaResponseException. May throw TooManyRequestsException. May throw LimitExceededException. May throw InvalidSmsRoleAccessPolicyException. May throw InvalidSmsRoleTrustRelationshipException. May throw InvalidEmailRoleAccessPolicyException. May throw CodeDeliveryFailureException. May throw UserNotFoundException. May throw UserNotConfirmedException. May throw InternalErrorException.

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

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

Parameter analyticsMetadata : The Amazon Pinpoint analytics metadata for collecting metrics for ForgotPassword 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 ForgotPassword API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, and user migration. When Amazon Cognito invokes any of these functions, 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 ForgotPassword 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<ForgotPasswordResponse> forgotPassword({
  required String clientId,
  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(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.ForgotPassword'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    signed: false,
    // TODO queryParams
    headers: headers,
    payload: {
      'ClientId': clientId,
      'Username': username,
      if (analyticsMetadata != null) 'AnalyticsMetadata': analyticsMetadata,
      if (clientMetadata != null) 'ClientMetadata': clientMetadata,
      if (secretHash != null) 'SecretHash': secretHash,
      if (userContextData != null) 'UserContextData': userContextData,
    },
  );

  return ForgotPasswordResponse.fromJson(jsonResponse.body);
}