Class: Aws::CognitoIdentityProvider::Types::AdminSetUserPasswordRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::CognitoIdentityProvider::Types::AdminSetUserPasswordRequest
- Defined in:
- gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[:username, :password]
Instance Attribute Summary collapse
-
#password ⇒ String
The new temporary or permanent password that you want to set for the user.
-
#permanent ⇒ Boolean
Set to
true
to set a password that the user can immediately sign in with. -
#user_pool_id ⇒ String
The ID of the user pool where you want to set the user's password.
-
#username ⇒ String
The username of the user that you want to query or modify.
Instance Attribute Details
#password ⇒ String
The new temporary or permanent password that you want to set for the user. You can't remove the password for a user who already has a password so that they can only sign in with passwordless methods. In this scenario, you must create a new user without a password.
2075 2076 2077 2078 2079 2080 2081 2082 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2075 class AdminSetUserPasswordRequest < Struct.new( :user_pool_id, :username, :password, :permanent) SENSITIVE = [:username, :password] include Aws::Structure end |
#permanent ⇒ Boolean
Set to true
to set a password that the user can immediately sign
in with. Set to false
to set a temporary password that the user
must change on their next sign-in.
2075 2076 2077 2078 2079 2080 2081 2082 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2075 class AdminSetUserPasswordRequest < Struct.new( :user_pool_id, :username, :password, :permanent) SENSITIVE = [:username, :password] include Aws::Structure end |
#user_pool_id ⇒ String
The ID of the user pool where you want to set the user's password.
2075 2076 2077 2078 2079 2080 2081 2082 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2075 class AdminSetUserPasswordRequest < Struct.new( :user_pool_id, :username, :password, :permanent) SENSITIVE = [:username, :password] include Aws::Structure end |
#username ⇒ 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.
2075 2076 2077 2078 2079 2080 2081 2082 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 2075 class AdminSetUserPasswordRequest < Struct.new( :user_pool_id, :username, :password, :permanent) SENSITIVE = [:username, :password] include Aws::Structure end |