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.

Constant Summary collapse

SENSITIVE =
[:username]

Instance Attribute Summary collapse

Instance Attribute Details

#attributesArray<Types::AttributeType>

A container with information about the user type attributes.

Returns:



10137
10138
10139
10140
10141
10142
10143
10144
10145
10146
10147
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10137

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

#enabledBoolean

Specifies whether the user is enabled.

Returns:

  • (Boolean)


10137
10138
10139
10140
10141
10142
10143
10144
10145
10146
10147
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10137

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

#mfa_optionsArray<Types::MFAOptionType>

The MFA options for the user.

Returns:



10137
10138
10139
10140
10141
10142
10143
10144
10145
10146
10147
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10137

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

#user_create_dateTime

The creation date of the user.

Returns:

  • (Time)


10137
10138
10139
10140
10141
10142
10143
10144
10145
10146
10147
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10137

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

#user_last_modified_dateTime

The last modified date of the user.

Returns:

  • (Time)


10137
10138
10139
10140
10141
10142
10143
10144
10145
10146
10147
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10137

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


10137
10138
10139
10140
10141
10142
10143
10144
10145
10146
10147
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10137

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

#usernameString

The user name of the user you wish to describe.

Returns:

  • (String)


10137
10138
10139
10140
10141
10142
10143
10144
10145
10146
10147
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10137

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