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 ForgotPassword operation.
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. To use the confirmation
code for resetting the password, call ConfirmForgotPassword.
If neither a verified phone number nor a verified email exists, this API returns InvalidParameterException
.
If your app client has a client secret and you don't provide a SECRET_HASH
parameter, this API returns NotAuthorizedException
.
To use this API operation, your user pool must have self-service account recovery configured. Use AdminSetUserPassword if you manage passwords as an administrator.
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.
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode, you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Namespace: Amazon.CognitoIdentityProvider.Model
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z
public class ForgotPasswordRequest : AmazonCognitoIdentityProviderRequest IAmazonWebServiceRequest
The ForgotPasswordRequest type exposes the following members
Name | Description | |
---|---|---|
ForgotPasswordRequest() |
Name | Type | Description | |
---|---|---|---|
AnalyticsMetadata | Amazon.CognitoIdentityProvider.Model.AnalyticsMetadataType |
Gets and sets the property AnalyticsMetadata.
The Amazon Pinpoint analytics metadata that contributes to your metrics for |
|
ClientId | System.String |
Gets and sets the property ClientId. The ID of the client associated with the user pool. |
|
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 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 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:
|
|
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. |
|
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. |
|
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
|
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5