ConfirmForgotPassword
Allows a user to enter a confirmation code to reset a forgotten password.
Request Syntax
{
"AnalyticsMetadata": {
"AnalyticsEndpointId": "string
"
},
"ClientId": "string
",
"ClientMetadata": {
"string
" : "string
"
},
"ConfirmationCode": "string
",
"Password": "string
",
"SecretHash": "string
",
"UserContextData": {
"EncodedData": "string
"
},
"Username": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- AnalyticsMetadata
-
The Amazon Pinpoint analytics metadata for collecting metrics for
ConfirmForgotPassword
calls.Type: AnalyticsMetadataType object
Required: No
- ClientId
-
The app client ID of the app associated with the user pool.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[\w+]+
Required: Yes
- 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 theclientMetadata
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.
Note Take the following limitations into consideration when you use the ClientMetadata parameter:
-
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.
Type: String to string map
Required: No
-
- ConfirmationCode
-
The confirmation code sent by a user's request to retrieve a forgotten password. For more information, see ForgotPassword.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
[\S]+
Required: Yes
- Password
-
The password sent by a user's request to retrieve a forgotten password.
Type: String
Length Constraints: Minimum length of 6. Maximum length of 256.
Pattern:
[\S]+
Required: Yes
- 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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[\w+=/]+
Required: No
- 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.
Type: UserContextDataType object
Required: No
- Username
-
The user name of the user for whom you want to enter a code to retrieve a forgotten password.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[\p{L}\p{M}\p{S}\p{N}\p{P}]+
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- CodeMismatchException
-
This exception is thrown if the provided code does not match what the server was expecting.
HTTP Status Code: 400
- ExpiredCodeException
-
This exception is thrown if a code has expired.
HTTP Status Code: 400
- InternalErrorException
-
This exception is thrown when Amazon Cognito encounters an internal error.
HTTP Status Code: 500
- InvalidLambdaResponseException
-
This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.
HTTP Status Code: 400
- InvalidParameterException
-
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
HTTP Status Code: 400
- InvalidPasswordException
-
This exception is thrown when the Amazon Cognito service encounters an invalid password.
HTTP Status Code: 400
- LimitExceededException
-
This exception is thrown when a user exceeds the limit for a requested AWS resource.
HTTP Status Code: 400
- NotAuthorizedException
-
This exception is thrown when a user is not authorized.
HTTP Status Code: 400
- ResourceNotFoundException
-
This exception is thrown when the Amazon Cognito service cannot find the requested resource.
HTTP Status Code: 400
- TooManyFailedAttemptsException
-
This exception is thrown when the user has made too many failed attempts for a given action (e.g., sign in).
HTTP Status Code: 400
- TooManyRequestsException
-
This exception is thrown when the user has made too many requests for a given operation.
HTTP Status Code: 400
- UnexpectedLambdaException
-
This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.
HTTP Status Code: 400
- UserLambdaValidationException
-
This exception is thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.
HTTP Status Code: 400
- UserNotConfirmedException
-
This exception is thrown when a user is not confirmed successfully.
HTTP Status Code: 400
- UserNotFoundException
-
This exception is thrown when a user is not found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: