AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the ConfirmForgotPassword operation. Allows a user to enter a confirmation code to reset a forgotten password.

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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CognitoIdentityProvider.AmazonCognitoIdentityProviderRequest
      Amazon.CognitoIdentityProvider.Model.ConfirmForgotPasswordRequest

Namespace: Amazon.CognitoIdentityProvider.Model
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z

Syntax

C# 
public class ConfirmForgotPasswordRequest : AmazonCognitoIdentityProviderRequest
         IAmazonWebServiceRequest

The ConfirmForgotPasswordRequest type exposes the following members

Constructors

NameDescription
Public Method ConfirmForgotPasswordRequest()

Properties

NameTypeDescription
Public Property AnalyticsMetadata Amazon.CognitoIdentityProvider.Model.AnalyticsMetadataType

Gets and sets the property AnalyticsMetadata.

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

Public Property ClientId System.String

Gets and sets the property ClientId.

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

Public Property ClientMetadata System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property 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 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.

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.

Public Property ConfirmationCode System.String

Gets and sets the property ConfirmationCode.

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

Public Property Password System.String

Gets and sets the property Password.

The new password that your user wants to set.

Public Property SecretHash System.String

Gets and sets the property 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. For more information about SecretHash, see Computing secret hash values.

Public Property UserContextData Amazon.CognitoIdentityProvider.Model.UserContextDataType

Gets and sets the property UserContextData.

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.

Public Property Username System.String

Gets and sets the property Username.

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.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5