You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::CognitoIdentityProvider::Types::UserType
- Inherits:
-
Struct
- Object
- Struct
- Aws::CognitoIdentityProvider::Types::UserType
- Defined in:
- (unknown)
Overview
Instance Attribute Summary collapse
-
#attributes ⇒ Array<Types::AttributeType>
A container with information about the user type attributes.
-
#enabled ⇒ Boolean
Specifies whether the user is enabled.
-
#mfa_options ⇒ Array<Types::MFAOptionType>
The MFA options for the user.
-
#user_create_date ⇒ Time
The creation date of the user.
-
#user_last_modified_date ⇒ Time
The last modified date of the user.
-
#user_status ⇒ String
The user status.
-
#username ⇒ String
The user name of the user you wish to describe.
Instance Attribute Details
#attributes ⇒ Array<Types::AttributeType>
A container with information about the user type attributes.
#enabled ⇒ Boolean
Specifies whether the user is enabled.
#mfa_options ⇒ Array<Types::MFAOptionType>
The MFA options for the user.
#user_create_date ⇒ Time
The creation date of the user.
#user_last_modified_date ⇒ Time
The last modified date of the user.
#user_status ⇒ String
The user status. Can be one of the following:
UNCONFIRMED - User has been created but not confirmed.
CONFIRMED - User has been confirmed.
ARCHIVED - User is no longer active.
COMPROMISED - User is disabled due to a potential security threat.
UNKNOWN - User status is not known.
RESET_REQUIRED - User is confirmed, but the user must request a code and reset his or her password before he or she can sign in.
FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change his or her password to a new value before doing anything else.
Possible values:
- UNCONFIRMED
- CONFIRMED
- ARCHIVED
- COMPROMISED
- UNKNOWN
- RESET_REQUIRED
- FORCE_CHANGE_PASSWORD
#username ⇒ String
The user name of the user you wish to describe.