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

Amazonka.CognitoIdentityProvider.Types.UserType

Description

Synopsis

data UserType = UserType' {
- attributes :: Maybe [AttributeType]
- enabled :: Maybe Bool
- mfaOptions :: Maybe [MFAOptionType]
- userCreateDate :: Maybe POSIX
- userLastModifiedDate :: Maybe POSIX
- userStatus :: Maybe UserStatusType
- username :: Maybe (Sensitive Text)
}
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

data UserType Source #

A user profile in a Amazon Cognito user pool.

See: newUserType smart constructor.

Constructors

UserType'

Fields

attributes :: Maybe [AttributeType]
A container with information about the user type attributes.
enabled :: Maybe Bool
Specifies whether the user is enabled.
mfaOptions :: Maybe [MFAOptionType]
The MFA options for the user.
userCreateDate :: Maybe POSIX
The creation date of the user.
userLastModifiedDate :: Maybe POSIX
The last modified date of the user.
userStatus :: Maybe UserStatusType
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.
username :: Maybe (Sensitive Text)
The user name of the user you want to describe.

Instances

Instances details

FromJSON UserType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.UserType Methods parseJSON :: Value -> Parser UserType # parseJSONList :: Value -> Parser [UserType] #
Generic UserType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.UserType Associated Types type Rep UserType :: Type -> Type # Methods from :: UserType -> Rep UserType x # to :: Rep UserType x -> UserType #
Show UserType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.UserType Methods showsPrec :: Int -> UserType -> ShowS # show :: UserType -> String # showList :: [UserType] -> ShowS #
NFData UserType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.UserType Methods rnf :: UserType -> () #
Eq UserType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.UserType Methods (==) :: UserType -> UserType -> Bool # (/=) :: UserType -> UserType -> Bool #
Hashable UserType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.UserType Methods hashWithSalt :: Int -> UserType -> Int # hash :: UserType -> Int #
type Rep UserType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.UserType type Rep UserType = D1 ('MetaData "UserType" "Amazonka.CognitoIdentityProvider.Types.UserType" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "UserType'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AttributeType])) :: (S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "mfaOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MFAOptionType])))) :: ((S1 ('MetaSel ('Just "userCreateDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "userLastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "userStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserStatusType)) :: S1 ('MetaSel ('Just "username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))))))

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_enabled :: Lens' UserType (Maybe Bool) Source #

Specifies whether the user is enabled.

userType_mfaOptions :: Lens' UserType (Maybe [MFAOptionType]) Source #

The MFA options for the user.

userType_userCreateDate :: Lens' UserType (Maybe UTCTime) Source #

The creation date of 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.

userType_username :: Lens' UserType (Maybe Text) Source #

The user name of the user you want to describe.