/

POST

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.

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",
    "UserContextData": {
        "IpAddress": "string",
        "EncodedData": "string"
    },
    "Username": "string",
    "AnalyticsMetadata": {},
    "ClientMetadata": {
        "property1": "string",
        "property2": "string"
    }
}'

Response Example

200 - Example 1

{
    "CodeDeliveryDetails": {
        "Destination": "string",
        "DeliveryMedium": "SMS",
        "AttributeName": "string"
    }
}

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

Represents the request to reset a user's password.

ClientId

string <password>

required

The ID of the client 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+=/]+

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.

Username

string <password>

required

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

>= 1 characters<= 128 characters

Match pattern:

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

AnalyticsMetadata

object

optional

The Amazon Pinpoint analytics metadata that contributes to your metrics for ForgotPassword calls.

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

The response from Amazon Cognito to a request to reset a password.

CodeDeliveryDetails

object

optional

The code delivery details returned by the server in response to the request to reset a password.

Destination

string

optional

The email address or phone number destination where Amazon Cognito sent the code.

DeliveryMedium

enum<string>

optional

The method that Amazon Cognito used to send the code.

Allowed values:

SMSEMAIL

AttributeName

string

optional

The name of the attribute that Amazon Cognito verifies with the code.

>= 1 characters<= 32 characters

Match pattern:

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

🟠480ResourceNotFoundException

🟠481InvalidParameterException

🟠482UnexpectedLambdaException

🟠483UserLambdaValidationException

🟠484NotAuthorizedException

🟠485InvalidLambdaResponseException

🟠486TooManyRequestsException

🟠487LimitExceededException

🟠488InvalidSmsRoleAccessPolicyException

🟠489InvalidSmsRoleTrustRelationshipException

🟠490InvalidEmailRoleAccessPolicyException

🟠491CodeDeliveryFailureException

🟠492UserNotFoundException

🟠493InternalErrorException

🟠494ForbiddenException

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