/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
/*
* Do not modify this file. This file is generated from the cognito-idp-2016-04-18.normal.json service model.
*/
using System;
using System.Collections.Generic;
using System.Xml.Serialization;
using System.Text;
using System.IO;
using System.Net;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
namespace Amazon.CognitoIdentityProvider.Model
{
///
/// 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
.
///
///
public partial class AdminSetUserPasswordRequest : AmazonCognitoIdentityProviderRequest
{
private string _password;
private bool? _permanent;
private string _username;
private string _userPoolId;
///
/// Gets and sets the property Password.
///
/// The password for the user.
///
///
[AWSProperty(Required=true, Sensitive=true, Max=256)]
public string Password
{
get { return this._password; }
set { this._password = value; }
}
// Check to see if Password property is set
internal bool IsSetPassword()
{
return this._password != null;
}
///
/// Gets and sets the property Permanent.
///
/// True
if the password is permanent, False
if it is temporary.
///
///
public bool Permanent
{
get { return this._permanent.GetValueOrDefault(); }
set { this._permanent = value; }
}
// Check to see if Permanent property is set
internal bool IsSetPermanent()
{
return this._permanent.HasValue;
}
///
/// Gets and sets the property Username.
///
/// The user name of the user whose password you want to set.
///
///
[AWSProperty(Required=true, Sensitive=true, Min=1, Max=128)]
public string Username
{
get { return this._username; }
set { this._username = value; }
}
// Check to see if Username property is set
internal bool IsSetUsername()
{
return this._username != null;
}
///
/// Gets and sets the property UserPoolId.
///
/// The user pool ID for the user pool where you want to set the user's password.
///
///
[AWSProperty(Required=true, Min=1, Max=55)]
public string UserPoolId
{
get { return this._userPoolId; }
set { this._userPoolId = value; }
}
// Check to see if UserPoolId property is set
internal bool IsSetUserPoolId()
{
return this._userPoolId != null;
}
}
}