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

Class: Aws::CognitoIdentityProvider::Types::UserType

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

Overview

The user type.

Instance Attribute Summary collapse

Instance Attribute Details

#attributesArray<Types::AttributeType>

A container with information about the user type attributes.

Returns:



8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 8557

class UserType < Struct.new(
  :username,
  :attributes,
  :user_create_date,
  :user_last_modified_date,
  :enabled,
  :user_status,
  :mfa_options)
  include Aws::Structure
end

#enabledBoolean

Specifies whether the user is enabled.

Returns:

  • (Boolean)


8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 8557

class UserType < Struct.new(
  :username,
  :attributes,
  :user_create_date,
  :user_last_modified_date,
  :enabled,
  :user_status,
  :mfa_options)
  include Aws::Structure
end

#mfa_optionsArray<Types::MFAOptionType>

The MFA options for the user.

Returns:



8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 8557

class UserType < Struct.new(
  :username,
  :attributes,
  :user_create_date,
  :user_last_modified_date,
  :enabled,
  :user_status,
  :mfa_options)
  include Aws::Structure
end

#user_create_dateTime

The creation date of the user.

Returns:

  • (Time)


8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 8557

class UserType < Struct.new(
  :username,
  :attributes,
  :user_create_date,
  :user_last_modified_date,
  :enabled,
  :user_status,
  :mfa_options)
  include Aws::Structure
end

#user_last_modified_dateTime

The last modified date of the user.

Returns:

  • (Time)


8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 8557

class UserType < Struct.new(
  :username,
  :attributes,
  :user_create_date,
  :user_last_modified_date,
  :enabled,
  :user_status,
  :mfa_options)
  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)


8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 8557

class UserType < Struct.new(
  :username,
  :attributes,
  :user_create_date,
  :user_last_modified_date,
  :enabled,
  :user_status,
  :mfa_options)
  include Aws::Structure
end

#usernameString

The user name of the user you wish to describe.

Returns:

  • (String)


8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 8557

class UserType < Struct.new(
  :username,
  :attributes,
  :user_create_date,
  :user_last_modified_date,
  :enabled,
  :user_status,
  :mfa_options)
  include Aws::Structure
end