Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

Class: Aws::CognitoIdentityProvider::Types::AdminGetUserResponse

Inherits:
Struct
  • Object
show all
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.

See Also:

Constant Summary collapse

SENSITIVE = 
[:username]

Instance Attribute Summary collapse

Instance Attribute Details

#enabled ⇒ Boolean

Indicates whether the user is activated for sign-in.

Returns:

  • (Boolean) 

852
853
854
855
856
857
858
859
860
861
862
863
864
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 852

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.

Returns:


852
853
854
855
856
857
858
859
860
861
862
863
864
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 852

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. Users can prefer SMS message, email message, or TOTP MFA.

Returns:

  • (String) 

852
853
854
855
856
857
858
859
860
861
862
863
864
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 852

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 of user attributes and their values, for example "email": "testuser@example.com".

Returns:


852
853
854
855
856
857
858
859
860
861
862
863
864
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 852

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 and time when the item was created. 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.

Returns:

  • (Time) 

852
853
854
855
856
857
858
859
860
861
862
863
864
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 852

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 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.

Returns:

  • (Time) 

852
853
854
855
856
857
858
859
860
861
862
863
864
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 852

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, EMAIL_OTP, and SOFTWARE_TOKEN_MFA.

Returns:

  • (Array<String>) 

852
853
854
855
856
857
858
859
860
861
862
863
864
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 852

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's status. Can be one of the following:

  • UNCONFIRMED - User has been created but not confirmed.

  • CONFIRMED - User has been confirmed.

  • 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.

  • EXTERNAL_PROVIDER - The user signed in with a third-party identity provider.

Returns:

  • (String) 

852
853
854
855
856
857
858
859
860
861
862
863
864
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 852

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 username of the user that you requested.

Returns:

  • (String) 

852
853
854
855
856
857
858
859
860
861
862
863
864
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 852

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