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

Inherits:

Struct

• Object
• Struct
• Aws::CognitoIdentityProvider::Types::GetUserResponse

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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:username]

Instance Attribute Summary

• #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_mfa_setting_list ⇒ Array<String>

  The MFA options that are activated for the user.

• #username ⇒ String

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

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:

• (Array<Types::MFAOptionType>)

# 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_setting ⇒ String

The user's preferred MFA setting.

Returns:

• (String)

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

• (Array<Types::AttributeType>)

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

Returns:

• (Array<String>)

# 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

#username ⇒ String

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

Returns:

• (String)

# 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