Struct aws_sdk_cognitoidentityprovider::operation::admin_set_user_password::builders::AdminSetUserPasswordFluentBuilder

pub struct AdminSetUserPasswordFluentBuilder { /* private fields */ }

Fluent builder constructing a request to AdminSetUserPassword.

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

• Signing Amazon Web Services API Requests

• Using the Amazon Cognito user pools API and user pool endpoints

Implementations

impl AdminSetUserPasswordFluentBuilder

pub fn as_input(&self) -> &AdminSetUserPasswordInputBuilder

Access the AdminSetUserPassword as a reference.

pub async fn send( self, ) -> Result<AdminSetUserPasswordOutput, SdkError<AdminSetUserPasswordError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self, ) -> CustomizableOperation<AdminSetUserPasswordOutput, AdminSetUserPasswordError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn user_pool_id(self, input: impl Into<String>) -> Self

The user pool ID for the user pool where you want to set the user's password.

pub fn set_user_pool_id(self, input: Option<String>) -> Self

The user pool ID for the user pool where you want to set the user's password.

pub fn get_user_pool_id(&self) -> &Option<String>

The user pool ID for the user pool where you want to set the user's password.

pub fn username(self, input: impl Into<String>) -> Self

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 username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

pub fn set_username(self, input: Option<String>) -> Self

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 username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

pub fn get_username(&self) -> &Option<String>

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 username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

pub fn password(self, input: impl Into<String>) -> Self

The password for the user.

pub fn set_password(self, input: Option<String>) -> Self

The password for the user.

pub fn get_password(&self) -> &Option<String>

The password for the user.

pub fn permanent(self, input: bool) -> Self

True if the password is permanent, False if it is temporary.

pub fn set_permanent(self, input: Option<bool>) -> Self

True if the password is permanent, False if it is temporary.

pub fn get_permanent(&self) -> &Option<bool>

True if the password is permanent, False if it is temporary.

Trait Implementations

impl Clone for AdminSetUserPasswordFluentBuilder

fn clone(&self) -> AdminSetUserPasswordFluentBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AdminSetUserPasswordFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.