Forgot Password
cognitoidentityprovider_forgot_password | R Documentation |
Sends a password-reset confirmation code for the currently signed-in user¶
Description¶
Sends a password-reset confirmation code for the currently signed-in user.
For the Username
parameter, you can use the username or user alias.
If neither a verified phone number nor a verified email exists, Amazon
Cognito responds with an InvalidParameterException
error . If your app
client has a client secret and you don't provide a SECRET_HASH
parameter, this API returns NotAuthorizedException
.
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 Services 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.
Usage¶
cognitoidentityprovider_forgot_password(ClientId, SecretHash,
UserContextData, Username, AnalyticsMetadata, ClientMetadata)
Arguments¶
ClientId |
[required] The ID of the user pool app client associated with the current signed-in user. |
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 |
UserContextData |
Contextual data about your user session like the device fingerprint, IP address, or location. Amazon Cognito threat protection 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. |
Username |
[required] The name 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 |
AnalyticsMetadata |
Information that supports analytics outcomes with Amazon Pinpoint, including the user's endpoint ID. The endpoint ID is a destination for Amazon Pinpoint push notifications, for example a device identifier, email address, or phone number. |
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 Using Lambda triggers in the Amazon Cognito Developer Guide. When you use the
|
Value¶
A list with the following syntax:
list(
CodeDeliveryDetails = list(
Destination = "string",
DeliveryMedium = "SMS"|"EMAIL",
AttributeName = "string"
)
)
Request syntax¶
svc$forgot_password(
ClientId = "string",
SecretHash = "string",
UserContextData = list(
IpAddress = "string",
EncodedData = "string"
),
Username = "string",
AnalyticsMetadata = list(
AnalyticsEndpointId = "string"
),
ClientMetadata = list(
"string"
)
)