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.
Sets the specified user's password in a user pool as an administrator. Works on any user.
The password can be temporary or permanent. If it is temporary, the user status enters
the FORCE_CHANGE_PASSWORD state. When the user next tries to sign in, the InitiateAuth/AdminInitiateAuth
response will contain the NEW_PASSWORD_REQUIRED challenge. If the user doesn't
sign in before it expires, the user won't be able to sign in, and an administrator
must reset their password.
Once the user has set a new password, or the password is permanent, the user status
is set to Confirmed.
AdminSetUserPassword can set a password for the user profile that Amazon Cognito
creates for third-party federated users. When you set a password, the federated user's
status changes from EXTERNAL_PROVIDER to CONFIRMED. A user in this state
can sign in as a federated user, and initiate authentication flows in the API like
a linked native user. They can also modify their password and attributes in token-authenticated
API requests like ChangePassword and UpdateUserAttributes. As a best
security practice and to keep users in sync with your external IdP, don't set passwords
on federated user profiles. To set up a federated user for native sign-in with a linked
native user, refer to Linking
federated users to an existing user profile.
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
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginAdminSetUserPassword and EndAdminSetUserPassword.
Namespace: Amazon.CognitoIdentityProvider
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z
public virtual Task<AdminSetUserPasswordResponse> AdminSetUserPasswordAsync( AdminSetUserPasswordRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the AdminSetUserPassword service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| InternalErrorException | This exception is thrown when Amazon Cognito encounters an internal error. |
| InvalidParameterException | This exception is thrown when the Amazon Cognito service encounters an invalid parameter. |
| InvalidPasswordException | This exception is thrown when Amazon Cognito encounters an invalid password. |
| NotAuthorizedException | This exception is thrown when a user isn't authorized. |
| ResourceNotFoundException | This exception is thrown when the Amazon Cognito service can't find the requested resource. |
| TooManyRequestsException | This exception is thrown when the user has made too many requests for a given operation. |
| UserNotFoundException | This exception is thrown when a user isn't found. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5