Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data UserType = UserType' {}
- newUserType :: UserType
- userType_attributes :: Lens' UserType (Maybe [AttributeType])
- userType_enabled :: Lens' UserType (Maybe Bool)
- userType_mfaOptions :: Lens' UserType (Maybe [MFAOptionType])
- userType_userCreateDate :: Lens' UserType (Maybe UTCTime)
- userType_userLastModifiedDate :: Lens' UserType (Maybe UTCTime)
- userType_userStatus :: Lens' UserType (Maybe UserStatusType)
- userType_username :: Lens' UserType (Maybe Text)
Documentation
A user profile in a Amazon Cognito user pool.
See: newUserType
smart constructor.
UserType' | |
|
Instances
newUserType :: UserType Source #
Create a value of UserType
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attributes:UserType'
, userType_attributes
- A container with information about the user type attributes.
$sel:enabled:UserType'
, userType_enabled
- Specifies whether the user is enabled.
$sel:mfaOptions:UserType'
, userType_mfaOptions
- The MFA options for the user.
$sel:userCreateDate:UserType'
, userType_userCreateDate
- The creation date of the user.
$sel:userLastModifiedDate:UserType'
, userType_userLastModifiedDate
- The last modified date of the user.
$sel:userStatus:UserType'
, userType_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.
- ARCHIVED - User is no longer active.
- 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.
$sel:username:UserType'
, userType_username
- The user name of the user you want to describe.
userType_attributes :: Lens' UserType (Maybe [AttributeType]) Source #
A container with information about the user type attributes.
userType_mfaOptions :: Lens' UserType (Maybe [MFAOptionType]) Source #
The MFA options for the user.
userType_userLastModifiedDate :: Lens' UserType (Maybe UTCTime) Source #
The last modified date of the user.
userType_userStatus :: Lens' UserType (Maybe UserStatusType) Source #
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.
- ARCHIVED - User is no longer active.
- 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.