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

Inherits:

Struct

• Object
• Struct
• Aws::CognitoIdentityProvider::Types::UserType

Includes:

Structure

Defined in:

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].

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminCreateUser.html [2]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ListUsers.html

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:username]

Instance Attribute Summary

• #attributes ⇒ Array<Types::AttributeType>

  Names and values of a user’s attributes, for example ‘email`.

• #enabled ⇒ Boolean

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

• #mfa_options ⇒ Array<Types::MFAOptionType>

  The user’s MFA configuration.

• #user_create_date ⇒ Time

  The date and time when the item was created.

• #user_last_modified_date ⇒ Time

  The date and time when the item was modified.

• #user_status ⇒ String

  The user status.

• #username ⇒ String

  The user’s username.

Instance Attribute Details

#attributes ⇒ Array<Types::AttributeType>

Names and values of a user’s attributes, for example ‘email`.

Returns:

• (Array<Types::AttributeType>)

# File '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

#enabled ⇒ Boolean

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

Returns:

• (Boolean)

# File '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_options ⇒ Array<Types::MFAOptionType>

The user’s MFA configuration.

Returns:

• (Array<Types::MFAOptionType>)

# File '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_date ⇒ Time

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)

# File '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_date ⇒ Time

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)

# File '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_status ⇒ String

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)

# File '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

#username ⇒ String

The user’s username.

Returns:

• (String)

# File '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