/

POST

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

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "ClientId": "string",
    "SecretHash": "string",
    "Username": "string",
    "ConfirmationCode": "string",
    "Password": "string",
    "AnalyticsMetadata": {},
    "UserContextData": {
        "IpAddress": "string",
        "EncodedData": "string"
    },
    "ClientMetadata": {
        "property1": "string",
        "property2": "string"
    }
}'

Response Example

200 - Example 1

{}

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

The request representing the confirmation for a password reset.

ClientId

string <password>

required

The app client ID of the app associated with the user pool.

>= 1 characters<= 128 characters

Match pattern:

[\w+]+

SecretHash

string <password>

optional

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.

>= 1 characters<= 128 characters

Match pattern:

[\w+=/]+

Username

string <password>

required

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

>= 1 characters<= 128 characters

Match pattern:

[\p{L}\p{M}\p{S}\p{N}\p{P}]+

ConfirmationCode

string

required

The confirmation code from your user's request to reset their password. For more information, see ForgotPassword.

>= 1 characters<= 2048 characters

Match pattern:

[\S]+

Password

string <password>

required

The new password that your user wants to set.

<= 256 characters

Match pattern:

[\S]+

AnalyticsMetadata

object

optional

The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmForgotPassword calls.

UserContextData

object

optional

Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security 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.

IpAddress

string

optional

The source IP address of your user's device.

EncodedData

string

optional

Encoded device-fingerprint details that your app collected with the Amazon Cognito context data collection library. For more information, see Adding user device and session data to API requests.

ClientMetadata

object

optional

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 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 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.

Examples

Responses

🟢200Success

application/json

Body

object {0}

🟠480ResourceNotFoundException

🟠481UnexpectedLambdaException

🟠482UserLambdaValidationException

🟠483InvalidParameterException

🟠484InvalidPasswordException

🟠485NotAuthorizedException

🟠486CodeMismatchException

🟠487ExpiredCodeException

🟠488TooManyFailedAttemptsException

🟠489InvalidLambdaResponseException

🟠490TooManyRequestsException

🟠491LimitExceededException

🟠492UserNotFoundException

🟠493UserNotConfirmedException

🟠494InternalErrorException

🟠495ForbiddenException

Modified at 2023-08-15 07:11:06