CognitoIdentityProvider / Client / confirm_forgot_password

confirm_forgot_password

CognitoIdentityProvider.Client.confirm_forgot_password(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.confirm_forgot_password(
    ClientId='string',
    SecretHash='string',
    Username='string',
    ConfirmationCode='string',
    Password='string',
    AnalyticsMetadata={
        'AnalyticsEndpointId': 'string'
    },
    UserContextData={
        'IpAddress': 'string',
        'EncodedData': 'string'
    },
    ClientMetadata={
        'string': 'string'
    }
)

Parameters:

• ClientId (string) –

  [REQUIRED]

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

• SecretHash (string) – 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.

• Username (string) –

  [REQUIRED]

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

• ConfirmationCode (string) –

  [REQUIRED]

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

• Password (string) –

  [REQUIRED]

  The new password that your user wants to set.

• AnalyticsMetadata (dict) –

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

  • AnalyticsEndpointId (string) –

    The endpoint ID.

• UserContextData (dict) –

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

    The source IP address of your user’s device.

  • EncodedData (string) –

    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 (dict) –

  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.

  Note

  When you use the ClientMetadata parameter, remember that Amazon Cognito won’t do the following:

  • 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 use Amazon Cognito to provide sensitive information.

  • (string) –

    • (string) –

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

• (dict) –

  The response from the server that results from a user’s request to retrieve a forgotten password.

Exceptions

• CognitoIdentityProvider.Client.exceptions.ResourceNotFoundException

• CognitoIdentityProvider.Client.exceptions.UnexpectedLambdaException

• CognitoIdentityProvider.Client.exceptions.UserLambdaValidationException

• CognitoIdentityProvider.Client.exceptions.InvalidParameterException

• CognitoIdentityProvider.Client.exceptions.InvalidPasswordException

• CognitoIdentityProvider.Client.exceptions.NotAuthorizedException

• CognitoIdentityProvider.Client.exceptions.CodeMismatchException

• CognitoIdentityProvider.Client.exceptions.ExpiredCodeException

• CognitoIdentityProvider.Client.exceptions.TooManyFailedAttemptsException

• CognitoIdentityProvider.Client.exceptions.InvalidLambdaResponseException

• CognitoIdentityProvider.Client.exceptions.TooManyRequestsException

• CognitoIdentityProvider.Client.exceptions.LimitExceededException

• CognitoIdentityProvider.Client.exceptions.UserNotFoundException

• CognitoIdentityProvider.Client.exceptions.UserNotConfirmedException

• CognitoIdentityProvider.Client.exceptions.InternalErrorException

• CognitoIdentityProvider.Client.exceptions.ForbiddenException