CognitoIdentityProvider / Client / confirm_forgot_password

confirm_forgot_password

CognitoIdentityProvider.Client.confirm_forgot_password(**kwargs)

This public API operation accepts a confirmation code that Amazon Cognito sent to a user and accepts a new password for that user.

Note

Amazon Cognito doesn’t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can’t use IAM credentials to authorize requests, and you can’t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

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 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’ passwords for all app clients in 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. For more information about SecretHash, see Computing secret hash values.

• Username (string) –

  [REQUIRED]

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

• ConfirmationCode (string) –

  [REQUIRED]

  The confirmation code that your user pool sent in response to an AdminResetUserPassword or a ForgotPassword request.

• 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. Information that you want to pass to Amazon Pinpoint about where to send notifications.

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

  For more information, see Collecting data for threat protection in applications.

  • 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, note 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 send sensitive information in this parameter.

  • (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.PasswordHistoryPolicyViolationException

• 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