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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

The user type.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#attributesArray<Types::AttributeType>

A container with information about the user type attributes.

Returns:

#enabledBoolean

Specifies whether the user is enabled.

Returns:

  • (Boolean)

    Specifies whether the user is enabled.

#mfa_optionsArray<Types::MFAOptionType>

The MFA options for the user.

Returns:

#user_create_dateTime

The creation date of the user.

Returns:

  • (Time)

    The creation date of the user.

#user_last_modified_dateTime

The last modified date of the user.

Returns:

  • (Time)

    The last modified date of the user.

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

    Possible values:

    • UNCONFIRMED
    • CONFIRMED
    • ARCHIVED
    • COMPROMISED
    • UNKNOWN
    • RESET_REQUIRED
    • FORCE_CHANGE_PASSWORD

Returns:

  • (String)

    The user status.

#usernameString

The user name of the user you wish to describe.

Returns:

  • (String)

    The user name of the user you wish to describe.