Class: Aws::CognitoIdentityProvider::Types::UserType
- Inherits:
-
Struct
- Object
- Struct
- Aws::CognitoIdentityProvider::Types::UserType
- Defined in:
- gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb
Overview
A user profile in a Amazon Cognito user pool.
Constant Summary collapse
- SENSITIVE =
[:username]
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 date and time when the item was modified.
-
#user_status ⇒ String
The user status.
-
#username ⇒ String
The user name of the user you want to describe.
Instance Attribute Details
#attributes ⇒ Array<Types::AttributeType>
A container with information about the user type attributes.
10915 10916 10917 10918 10919 10920 10921 10922 10923 10924 10925 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10915 class UserType < Struct.new( :username, :attributes, :user_create_date, :user_last_modified_date, :enabled, :user_status, :mfa_options) SENSITIVE = [:username] include Aws::Structure end |
#enabled ⇒ Boolean
Specifies whether the user is enabled.
10915 10916 10917 10918 10919 10920 10921 10922 10923 10924 10925 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10915 class UserType < Struct.new( :username, :attributes, :user_create_date, :user_last_modified_date, :enabled, :user_status, :mfa_options) SENSITIVE = [:username] include Aws::Structure end |
#mfa_options ⇒ Array<Types::MFAOptionType>
The MFA options for the user.
10915 10916 10917 10918 10919 10920 10921 10922 10923 10924 10925 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10915 class UserType < Struct.new( :username, :attributes, :user_create_date, :user_last_modified_date, :enabled, :user_status, :mfa_options) SENSITIVE = [:username] include Aws::Structure end |
#user_create_date ⇒ Time
The creation date of the user.
10915 10916 10917 10918 10919 10920 10921 10922 10923 10924 10925 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10915 class UserType < Struct.new( :username, :attributes, :user_create_date, :user_last_modified_date, :enabled, :user_status, :mfa_options) SENSITIVE = [:username] include Aws::Structure end |
#user_last_modified_date ⇒ Time
The date and time when the item was modified. Amazon Cognito returns
this timestamp in UNIX epoch time format. Your SDK might render the
output in a human-readable format like ISO 8601 or a Java Date
object.
10915 10916 10917 10918 10919 10920 10921 10922 10923 10924 10925 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10915 class UserType < Struct.new( :username, :attributes, :user_create_date, :user_last_modified_date, :enabled, :user_status, :mfa_options) SENSITIVE = [:username] include Aws::Structure end |
#user_status ⇒ String
The user status. This can be one of the following:
UNCONFIRMED - User has been created but not confirmed.
CONFIRMED - User has been confirmed.
EXTERNAL_PROVIDER - User signed in with a third-party IdP.
UNKNOWN - User status isn't known.
RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they 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 their password to a new value before doing anything else.
10915 10916 10917 10918 10919 10920 10921 10922 10923 10924 10925 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10915 class UserType < Struct.new( :username, :attributes, :user_create_date, :user_last_modified_date, :enabled, :user_status, :mfa_options) SENSITIVE = [:username] include Aws::Structure end |
#username ⇒ String
The user name of the user you want to describe.
10915 10916 10917 10918 10919 10920 10921 10922 10923 10924 10925 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10915 class UserType < Struct.new( :username, :attributes, :user_create_date, :user_last_modified_date, :enabled, :user_status, :mfa_options) SENSITIVE = [:username] include Aws::Structure end |