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

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

Overview

A user profile in a Amazon Cognito user pool.

This data type is a response parameter to AdminCreateUser and ListUsers.

Constant Summary collapse

SENSITIVE =
[:username]

Instance Attribute Summary collapse

Instance Attribute Details

#attributesArray<Types::AttributeType>

Names and values of a user's attributes, for example email.

Returns:



13261
13262
13263
13264
13265
13266
13267
13268
13269
13270
13271
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 13261

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

Indicates whether the user's account is enabled or disabled.

Returns:

  • (Boolean)


13261
13262
13263
13264
13265
13266
13267
13268
13269
13270
13271
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 13261

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 user's MFA configuration.

Returns:



13261
13262
13263
13264
13265
13266
13267
13268
13269
13270
13271
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 13261

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 date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

Returns:

  • (Time)


13261
13262
13263
13264
13265
13266
13267
13268
13269
13270
13271
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 13261

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 date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

Returns:

  • (Time)


13261
13262
13263
13264
13265
13266
13267
13268
13269
13270
13271
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 13261

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. This can be one of the following:

  • UNCONFIRMED - User has been created but not confirmed.

  • CONFIRMED - User has been confirmed.

  • EXTERNAL_PROVIDER - User signed in with a third-party IdP.

  • UNKNOWN - User status isn't known.

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

Returns:

  • (String)


13261
13262
13263
13264
13265
13266
13267
13268
13269
13270
13271
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 13261

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's username.

Returns:

  • (String)


13261
13262
13263
13264
13265
13266
13267
13268
13269
13270
13271
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 13261

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