Class: Aws::CognitoIdentityProvider::Types::GetUserResponse

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

Represents the response from the server from the request to get information about the user.

See Also:

Constant Summary collapse

SENSITIVE = 
[:username]

Instance Attribute Summary collapse

Instance Attribute Details

#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:



5261
5262
5263
5264
5265
5266
5267
5268
5269
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 5261

class GetUserResponse < Struct.new(
  :username,
  :user_attributes,
  :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.

Returns:

  • (String) 


5261
5262
5263
5264
5265
5266
5267
5268
5269
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 5261

class GetUserResponse < Struct.new(
  :username,
  :user_attributes,
  :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.

For custom attributes, you must prepend the ‘custom:` prefix to the attribute name.

Returns:



5261
5262
5263
5264
5265
5266
5267
5268
5269
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 5261

class GetUserResponse < Struct.new(
  :username,
  :user_attributes,
  :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>) 


5261
5262
5263
5264
5265
5266
5267
5268
5269
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 5261

class GetUserResponse < Struct.new(
  :username,
  :user_attributes,
  :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) 


5261
5262
5263
5264
5265
5266
5267
5268
5269
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 5261

class GetUserResponse < Struct.new(
  :username,
  :user_attributes,
  :mfa_options,
  :preferred_mfa_setting,
  :user_mfa_setting_list)
  SENSITIVE = [:username]
  include Aws::Structure
end