confirmForgotPassword method
This public API operation accepts a confirmation code that Amazon Cognito sent to a user and accepts a new password for that user.
May throw CodeMismatchException.
May throw ExpiredCodeException.
May throw ForbiddenException.
May throw InternalErrorException.
May throw InvalidLambdaResponseException.
May throw InvalidParameterException.
May throw InvalidPasswordException.
May throw LimitExceededException.
May throw NotAuthorizedException.
May throw OperationNotEnabledException.
May throw PasswordHistoryPolicyViolationException.
May throw ResourceNotFoundException.
May throw TooManyFailedAttemptsException.
May throw TooManyRequestsException.
May throw UnexpectedLambdaException.
May throw UserLambdaValidationException.
May throw UserNotConfirmedException.
May throw UserNotFoundException.
Parameter clientId :
The ID of the app client where the user wants to reset their password.
This parameter is an identifier of the client application that users are
resetting their password from, but this operation resets users'
irrespective of the app clients they sign in to.
Parameter confirmationCode :
The confirmation code that your user pool delivered when your user
requested to reset their password.
Parameter password :
The new password that your user wants to set.
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
ClientMetadatavalue. 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, theClientMetadataparameter serves no purpose. -
Validate the
ClientMetadatavalue. -
Encrypt the
ClientMetadatavalue. 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<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 {
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,
},
);
}