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

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.

Instance Attribute Summary collapse

Instance Attribute Details

#enabledBoolean

Indicates that the status is enabled.

Returns:

  • (Boolean)


808
809
810
811
812
813
814
815
816
817
818
819
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 808

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)
  include Aws::Structure
end

#mfa_optionsArray<Types::MFAOptionType>

Specifies the options for MFA (e.g., email or phone number).

Returns:



808
809
810
811
812
813
814
815
816
817
818
819
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 808

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)
  include Aws::Structure
end

#preferred_mfa_settingString

The user's preferred MFA setting.

Returns:

  • (String)


808
809
810
811
812
813
814
815
816
817
818
819
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 808

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)
  include Aws::Structure
end

#user_attributesArray<Types::AttributeType>

An array of name-value pairs representing user attributes.

Returns:



808
809
810
811
812
813
814
815
816
817
818
819
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 808

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)
  include Aws::Structure
end

#user_create_dateTime

The date the user was created.

Returns:

  • (Time)


808
809
810
811
812
813
814
815
816
817
818
819
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 808

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)
  include Aws::Structure
end

#user_last_modified_dateTime

The date the user was last modified.

Returns:

  • (Time)


808
809
810
811
812
813
814
815
816
817
818
819
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 808

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)
  include Aws::Structure
end

#user_mfa_setting_listArray<String>

The list of the user's MFA settings.

Returns:

  • (Array<String>)


808
809
810
811
812
813
814
815
816
817
818
819
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 808

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)
  include Aws::Structure
end

#user_statusString

The user status. Can be one of the following:

  • UNCONFIRMED - User has been created but not confirmed.

  • CONFIRMED - User has been confirmed.

  • ARCHIVED - User is no longer active.

  • COMPROMISED - User is disabled due to a potential security threat.

  • UNKNOWN - User status is not known.

  • RESET_REQUIRED - User is confirmed, but the user must request a code and reset his or her password before he or she 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 his or her password to a new value before doing anything else.

Returns:

  • (String)


808
809
810
811
812
813
814
815
816
817
818
819
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 808

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)
  include Aws::Structure
end

#usernameString

The user name of the user about whom you are receiving information.

Returns:

  • (String)


808
809
810
811
812
813
814
815
816
817
818
819
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 808

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)
  include Aws::Structure
end