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

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 information about the user.

Constant Summary collapse

SENSITIVE =
[:username]

Instance Attribute Summary collapse

Instance Attribute Details

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



5742
5743
5744
5745
5746
5747
5748
5749
5750
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5742

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

#preferred_mfa_settingString

The user's preferred MFA setting.

Returns:

  • (String)


5742
5743
5744
5745
5746
5747
5748
5749
5750
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5742

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

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



5742
5743
5744
5745
5746
5747
5748
5749
5750
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5742

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_listArray<String>

The MFA options that are activated for the user. The possible values in this list are SMS_MFA and SOFTWARE_TOKEN_MFA.

Returns:

  • (Array<String>)


5742
5743
5744
5745
5746
5747
5748
5749
5750
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5742

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

#usernameString

The user name of the user you want to retrieve from the get user request.

Returns:

  • (String)


5742
5743
5744
5745
5746
5747
5748
5749
5750
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5742

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