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

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class AdminResetUserPasswordRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable
```
Resets the specified user's password in a user pool as an administrator. Works on any user.

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
- 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

AdminResetUserPasswordRequest()

Constructors
Constructor and Description
`AdminResetUserPasswordRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AdminResetUserPasswordRequest`	`addClientMetadataEntry(java.lang.String key, java.lang.String value)` A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
`AdminResetUserPasswordRequest`	`clearClientMetadataEntries()` Removes all the entries added into ClientMetadata.
`boolean`	`equals(java.lang.Object obj)`
`java.util.Map<java.lang.String,java.lang.String>`	`getClientMetadata()` A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
`java.lang.String`	`getUsername()` The user name of the user whose password you want to reset.
`java.lang.String`	`getUserPoolId()` The user pool ID for the user pool where you want to reset the user's password.
`int`	`hashCode()`
`void`	`setClientMetadata(java.util.Map<java.lang.String,java.lang.String> clientMetadata)` A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
`void`	`setUsername(java.lang.String username)` The user name of the user whose password you want to reset.
`void`	`setUserPoolId(java.lang.String userPoolId)` The user pool ID for the user pool where you want to reset the user's password.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`AdminResetUserPasswordRequest`	`withClientMetadata(java.util.Map<java.lang.String,java.lang.String> clientMetadata)` A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
`AdminResetUserPasswordRequest`	`withUsername(java.lang.String username)` The user name of the user whose password you want to reset.
`AdminResetUserPasswordRequest`	`withUserPoolId(java.lang.String userPoolId)` The user pool ID for the user pool where you want to reset 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
  - AdminResetUserPasswordRequest
```
public AdminResetUserPasswordRequest()
```
- Method Detail
  - getUserPoolId
```
public java.lang.String getUserPoolId()
```
    The user pool ID for the user pool where you want to reset 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 reset the user's password.
  - setUserPoolId
```
public void setUserPoolId(java.lang.String userPoolId)
```
    The user pool ID for the user pool where you want to reset 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 reset the user's password.
  - withUserPoolId
```
public AdminResetUserPasswordRequest withUserPoolId(java.lang.String userPoolId)
```
    The user pool ID for the user pool where you want to reset 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 reset 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 reset.
    
    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 reset.
  - setUsername
```
public void setUsername(java.lang.String username)
```
    The user name of the user whose password you want to reset.
    
    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 reset.
  - withUsername
```
public AdminResetUserPasswordRequest withUsername(java.lang.String username)
```
    The user name of the user whose password you want to reset.
    
    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 reset.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getClientMetadata
```
public java.util.Map<java.lang.String,java.lang.String> getClientMetadata()
```
    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 clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminResetUserPassword request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
    
    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:
    
    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
    
    Validate the ClientMetadata value.
    
    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
    Returns:
    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 clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminResetUserPassword request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
    
    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:
    
    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
    
    Validate the ClientMetadata value.
    
    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
  - setClientMetadata
```
public void setClientMetadata(java.util.Map<java.lang.String,java.lang.String> 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 clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminResetUserPassword request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
    
    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:
    
    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
    
    Validate the ClientMetadata value.
    
    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
    Parameters:
    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 clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminResetUserPassword request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
    
    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:
    
    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
    
    Validate the ClientMetadata value.
    
    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
  - withClientMetadata
```
public AdminResetUserPasswordRequest withClientMetadata(java.util.Map<java.lang.String,java.lang.String> 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 clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminResetUserPassword request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
    
    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:
    
    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
    
    Validate the ClientMetadata value.
    
    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
    Returns a reference to this object so that method calls can be chained together.
    Parameters:
    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 clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminResetUserPassword request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
    
    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:
    
    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
    
    Validate the ClientMetadata value.
    
    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addClientMetadataEntry
```
public AdminResetUserPasswordRequest addClientMetadataEntry(java.lang.String key,
                                                            java.lang.String value)
```
    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 clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminResetUserPassword request. In your function code in Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
    
    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:
    
    Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
    
    Validate the ClientMetadata value.
    
    Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
    The method adds a new key-value pair into ClientMetadata parameter, and returns a reference to this object so that method calls can be chained together.
    Parameters:
    
    key - The key of the entry to be added into ClientMetadata.
    
    value - The corresponding value of the entry to be added into ClientMetadata.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - clearClientMetadataEntries
```
public AdminResetUserPasswordRequest clearClientMetadataEntries()
```
    Removes all the entries added into ClientMetadata.
    Returns a reference to this 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 AdminResetUserPasswordRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

AdminResetUserPasswordRequest

Method Detail

getUserPoolId

setUserPoolId

withUserPoolId

getUsername

setUsername

withUsername

getClientMetadata

setClientMetadata

withClientMetadata

addClientMetadataEntry

clearClientMetadataEntries

toString

hashCode

equals