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 AdminResetUserPassword operation. Resets the specified user's password in a user pool as an administrator. Works on any user.
To use this API operation, your user pool must have self-service account recovery configured. Use AdminSetUserPassword if you manage passwords as an administrator.
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.
Deactivates a user's password, requiring them to change it. If a user tries to sign
in after the API is called, Amazon Cognito responds with a PasswordResetRequiredException
error. Your app must then perform the actions that reset your user's password: the
forgot-password flow. In addition, if the user pool has phone verification selected
and a verified phone number exists for the user, or if email verification is selected
and a verified email exists for the user, calling this API will also result in sending
a message to the end user with the code to change their password.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Namespace: Amazon.CognitoIdentityProvider.Model
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z
public class AdminResetUserPasswordRequest : AmazonCognitoIdentityProviderRequest IAmazonWebServiceRequest
The AdminResetUserPasswordRequest type exposes the following members
Name | Description | |
---|---|---|
AdminResetUserPasswordRequest() |
Name | Type | Description | |
---|---|---|---|
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 AdminResetUserPassword API action, Amazon Cognito invokes the function
that is assigned to the custom message trigger. When Amazon Cognito invokes
this function, 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:
|
|
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
|
|
UserPoolId | System.String |
Gets and sets the property UserPoolId. The user pool ID for the user pool where you want to reset the user's password. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5