forgotPassword method

Future<ForgotPasswordResponse> forgotPassword({
  1. required String clientId,
  2. required String username,
  3. AnalyticsMetadataType? analyticsMetadata,
  4. Map<String, String>? clientMetadata,
  5. String? secretHash,
  6. UserContextDataType? userContextData,
})

Sends a password-reset confirmation code to the email address or phone number of the requested username. The message delivery method is determined by the user's available attributes and the AccountRecoverySetting configuration of the user pool.

For the Username parameter, you can use the username or an email, phone, or preferred username alias.

If neither a verified phone number nor a verified email exists, Amazon Cognito responds with an InvalidParameterException error . If your app client has a client secret and you don't provide a SECRET_HASH parameter, this API returns NotAuthorizedException.

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.

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

Parameter clientId : The ID of the user pool app client associated with the current signed-in user.

Parameter username : The name of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

Parameter analyticsMetadata : Information that supports analytics outcomes with Amazon Pinpoint, including the user's endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier, email address, or phone number.

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 Lambda functions to user pool triggers.

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 that provides the data that you assigned to the ClientMetadata parameter in your request. In your function code, you can process the clientMetadata value to enhance your workflow for your specific needs.

To review the Lambda trigger types that Amazon Cognito invokes at runtime with API requests, see Connecting API actions to Lambda triggers in the Amazon Cognito Developer Guide.

  • Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
  • Validate the ClientMetadata value.
  • Encrypt the ClientMetadata value. Don't send sensitive information in this parameter.

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. For more information about SecretHash, see Computing secret hash values.

Parameter userContextData : Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat protection evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.

For more information, see Collecting data for threat protection in applications.

Implementation

Future<ForgotPasswordResponse> forgotPassword({
  required String clientId,
  required String username,
  AnalyticsMetadataType? analyticsMetadata,
  Map<String, String>? clientMetadata,
  String? secretHash,
  UserContextDataType? userContextData,
}) async {
  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);
}