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 AdminSetUserPassword operation. 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
Namespace: Amazon.CognitoIdentityProvider.Model
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z
public class AdminSetUserPasswordRequest : AmazonCognitoIdentityProviderRequest IAmazonWebServiceRequest
The AdminSetUserPasswordRequest type exposes the following members
Name | Description | |
---|---|---|
AdminSetUserPasswordRequest() |
Name | Type | Description | |
---|---|---|---|
Password | System.String |
Gets and sets the property Password. The password for the user. |
|
Permanent | System.Boolean |
Gets and sets the property Permanent.
|
|
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 set 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