AdminSetUserPasswordRequest (aws-android-sdk-cognitoidentityprovider 2.81.1 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.cognitoidentityprovider.model.AdminSetUserPasswordRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class AdminSetUserPasswordRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable
```
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
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

AdminSetUserPasswordRequest()

Constructors
Constructor and Description
`AdminSetUserPasswordRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getPassword()` The password for the user.
`java.lang.Boolean`	`getPermanent()` `True` if the password is permanent, `False` if it is temporary.
`java.lang.String`	`getUsername()` The user name of the user whose password you want to set.
`java.lang.String`	`getUserPoolId()` The user pool ID for the user pool where you want to set the user's password.
`int`	`hashCode()`
`java.lang.Boolean`	`isPermanent()` `True` if the password is permanent, `False` if it is temporary.
`void`	`setPassword(java.lang.String password)` The password for the user.
`void`	`setPermanent(java.lang.Boolean permanent)` `True` if the password is permanent, `False` if it is temporary.
`void`	`setUsername(java.lang.String username)` The user name of the user whose password you want to set.
`void`	`setUserPoolId(java.lang.String userPoolId)` The user pool ID for the user pool where you want to set the user's password.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`AdminSetUserPasswordRequest`	`withPassword(java.lang.String password)` The password for the user.
`AdminSetUserPasswordRequest`	`withPermanent(java.lang.Boolean permanent)` `True` if the password is permanent, `False` if it is temporary.
`AdminSetUserPasswordRequest`	`withUsername(java.lang.String username)` The user name of the user whose password you want to set.
`AdminSetUserPasswordRequest`	`withUserPoolId(java.lang.String userPoolId)` The user pool ID for the user pool where you want to set the user's password.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AdminSetUserPasswordRequest
```
public AdminSetUserPasswordRequest()
```
- Method Detail
  - getUserPoolId
```
public java.lang.String getUserPoolId()
```
    The user pool ID for the user pool where you want to set the user's password.
    
    Constraints:
    Length: 1 - 55
    Pattern: [\w-]+_[0-9a-zA-Z]+
    
    Returns:
    
    The user pool ID for the user pool where you want to set the user's password.
  - setUserPoolId
```
public void setUserPoolId(java.lang.String userPoolId)
```
    The user pool ID for the user pool where you want to set the user's password.
    
    Constraints:
    Length: 1 - 55
    Pattern: [\w-]+_[0-9a-zA-Z]+
    
    Parameters:
    
    userPoolId -
    The user pool ID for the user pool where you want to set the user's password.
  - withUserPoolId
```
public AdminSetUserPasswordRequest withUserPoolId(java.lang.String userPoolId)
```
    The user pool ID for the user pool where you want to set the user's password.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 55
    Pattern: [\w-]+_[0-9a-zA-Z]+
    
    Parameters:
    
    userPoolId -
    The user pool ID for the user pool where you want to set the user's password.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getUsername
```
public java.lang.String getUsername()
```
    The user name of the user whose password you want to set.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
    
    Returns:
    
    The user name of the user whose password you want to set.
  - setUsername
```
public void setUsername(java.lang.String username)
```
    The user name of the user whose password you want to set.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
    
    Parameters:
    
    username -
    The user name of the user whose password you want to set.
  - withUsername
```
public AdminSetUserPasswordRequest withUsername(java.lang.String username)
```
    The user name of the user whose password you want to set.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 128
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
    
    Parameters:
    
    username -
    The user name of the user whose password you want to set.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getPassword
```
public java.lang.String getPassword()
```
    The password for the user.
    
    Constraints:
    Length: - 256
    Pattern: [\S]+
    
    Returns:
    
    The password for the user.
  - setPassword
```
public void setPassword(java.lang.String password)
```
    The password for the user.
    
    Constraints:
    Length: - 256
    Pattern: [\S]+
    
    Parameters:
    
    password -
    The password for the user.
  - withPassword
```
public AdminSetUserPasswordRequest withPassword(java.lang.String password)
```
    The password for the user.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: - 256
    Pattern: [\S]+
    
    Parameters:
    
    password -
    The password for the user.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - isPermanent
```
public java.lang.Boolean isPermanent()
```
    True if the password is permanent, False if it is temporary.
    
    Returns:
    
    True if the password is permanent, False if it is temporary.
  - getPermanent
```
public java.lang.Boolean getPermanent()
```
    True if the password is permanent, False if it is temporary.
    
    Returns:
    
    True if the password is permanent, False if it is temporary.
  - setPermanent
```
public void setPermanent(java.lang.Boolean permanent)
```
    True if the password is permanent, False if it is temporary.
    
    Parameters:
    
    permanent -
    True if the password is permanent, False if it is temporary.
  - withPermanent
```
public AdminSetUserPasswordRequest withPermanent(java.lang.Boolean permanent)
```
    True if the password is permanent, False if it is temporary.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    permanent -
    True if the password is permanent, False if it is temporary.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class AdminSetUserPasswordRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

AdminSetUserPasswordRequest

Method Detail

getUserPoolId

setUserPoolId

withUserPoolId

getUsername

setUsername

withUsername

getPassword

setPassword

withPassword

isPermanent

getPermanent

setPermanent

withPermanent

toString

hashCode

equals