Class: Aws::CognitoIdentityProvider::Types::AdminGetUserResponse
- Inherits:
-
Struct
- Object
- Struct
- Aws::CognitoIdentityProvider::Types::AdminGetUserResponse
- Defined in:
- gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb
Overview
Represents the response from the server from the request to get the specified user as an administrator.
Constant Summary collapse
- SENSITIVE =
[:username]
Instance Attribute Summary collapse
-
#enabled ⇒ Boolean
Indicates that the status is
enabled
. -
#mfa_options ⇒ Array<Types::MFAOptionType>
This response parameter is no longer supported. It provides information only about SMS MFA configurations.
-
#preferred_mfa_setting ⇒ String
The user's preferred MFA setting.
-
#user_attributes ⇒ Array<Types::AttributeType>
An array of name-value pairs representing user attributes.
-
#user_create_date ⇒ Time
The date the user was created.
-
#user_last_modified_date ⇒ Time
The date the user was last modified.
-
#user_mfa_setting_list ⇒ Array<String>
The MFA options that are activated for the user.
-
#user_status ⇒ String
The user status.
-
#username ⇒ String
The user name of the user about whom you're receiving information.
Instance Attribute Details
#enabled ⇒ Boolean
Indicates that the status is enabled
.
715 716 717 718 719 720 721 722 723 724 725 726 727 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 715 class AdminGetUserResponse < Struct.new( :username, :user_attributes, :user_create_date, :user_last_modified_date, :enabled, :user_status, :mfa_options, :preferred_mfa_setting, :user_mfa_setting_list) SENSITIVE = [:username] include Aws::Structure end |
#mfa_options ⇒ Array<Types::MFAOptionType>
This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.
715 716 717 718 719 720 721 722 723 724 725 726 727 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 715 class AdminGetUserResponse < Struct.new( :username, :user_attributes, :user_create_date, :user_last_modified_date, :enabled, :user_status, :mfa_options, :preferred_mfa_setting, :user_mfa_setting_list) SENSITIVE = [:username] include Aws::Structure end |
#preferred_mfa_setting ⇒ String
The user's preferred MFA setting.
715 716 717 718 719 720 721 722 723 724 725 726 727 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 715 class AdminGetUserResponse < Struct.new( :username, :user_attributes, :user_create_date, :user_last_modified_date, :enabled, :user_status, :mfa_options, :preferred_mfa_setting, :user_mfa_setting_list) SENSITIVE = [:username] include Aws::Structure end |
#user_attributes ⇒ Array<Types::AttributeType>
An array of name-value pairs representing user attributes.
715 716 717 718 719 720 721 722 723 724 725 726 727 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 715 class AdminGetUserResponse < Struct.new( :username, :user_attributes, :user_create_date, :user_last_modified_date, :enabled, :user_status, :mfa_options, :preferred_mfa_setting, :user_mfa_setting_list) SENSITIVE = [:username] include Aws::Structure end |
#user_create_date ⇒ Time
The date the user was created.
715 716 717 718 719 720 721 722 723 724 725 726 727 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 715 class AdminGetUserResponse < Struct.new( :username, :user_attributes, :user_create_date, :user_last_modified_date, :enabled, :user_status, :mfa_options, :preferred_mfa_setting, :user_mfa_setting_list) SENSITIVE = [:username] include Aws::Structure end |
#user_last_modified_date ⇒ Time
The date the user was last modified.
715 716 717 718 719 720 721 722 723 724 725 726 727 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 715 class AdminGetUserResponse < Struct.new( :username, :user_attributes, :user_create_date, :user_last_modified_date, :enabled, :user_status, :mfa_options, :preferred_mfa_setting, :user_mfa_setting_list) SENSITIVE = [:username] include Aws::Structure end |
#user_mfa_setting_list ⇒ Array<String>
The MFA options that are activated for the user. The possible values
in this list are SMS_MFA
and SOFTWARE_TOKEN_MFA
.
715 716 717 718 719 720 721 722 723 724 725 726 727 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 715 class AdminGetUserResponse < Struct.new( :username, :user_attributes, :user_create_date, :user_last_modified_date, :enabled, :user_status, :mfa_options, :preferred_mfa_setting, :user_mfa_setting_list) SENSITIVE = [:username] include Aws::Structure end |
#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.
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.
715 716 717 718 719 720 721 722 723 724 725 726 727 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 715 class AdminGetUserResponse < Struct.new( :username, :user_attributes, :user_create_date, :user_last_modified_date, :enabled, :user_status, :mfa_options, :preferred_mfa_setting, :user_mfa_setting_list) SENSITIVE = [:username] include Aws::Structure end |
#username ⇒ String
The user name of the user about whom you're receiving information.
715 716 717 718 719 720 721 722 723 724 725 726 727 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 715 class AdminGetUserResponse < Struct.new( :username, :user_attributes, :user_create_date, :user_last_modified_date, :enabled, :user_status, :mfa_options, :preferred_mfa_setting, :user_mfa_setting_list) SENSITIVE = [:username] include Aws::Structure end |