UserType
A user profile in a Amazon Cognito user pool.
This data type is a response parameter to AdminCreateUser and ListUsers.
Contents
- Attributes
-
Names and values of a user's attributes, for example
email.Type: Array of AttributeType objects
Required: No
- Enabled
-
Indicates whether the user's account is enabled or disabled.
Type: Boolean
Required: No
- MFAOptions
-
The user's MFA configuration.
Type: Array of MFAOptionType objects
Required: No
- UserCreateDate
-
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
Dateobject.Type: Timestamp
Required: No
- UserLastModifiedDate
-
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
Dateobject.Type: Timestamp
Required: No
- Username
-
The user's username.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[\p{L}\p{M}\p{S}\p{N}\p{P}]+Required: No
- UserStatus
-
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. -
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.
The statuses
ARCHIVED,UNKNOWN, andCOMPROMISEDare no longer used.Type: String
Valid Values:
UNCONFIRMED | CONFIRMED | ARCHIVED | COMPROMISED | UNKNOWN | RESET_REQUIRED | FORCE_CHANGE_PASSWORD | EXTERNAL_PROVIDERRequired: No
-
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: