You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

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

Returned by:

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 TOTP software token MFA configurations. To look up information about either type of MFA configuration, use the use the GetUserResponse$UserMFASettingList response instead.

Returns:

  • (Array<Types::MFAOptionType>)

    This response parameter is no longer supported. It provides information only about SMS MFA configurations.

#preferred_mfa_settingString

The user\'s preferred MFA setting.

Returns:

  • (String)

    The user\'s preferred MFA setting.

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

#user_mfa_setting_listArray<String>

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

Returns:

  • (Array<String>)

    The MFA options that are enabled for the user.

#usernameString

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

Returns:

  • (String)

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