libZSservicesZSamazonka-cognito-idpZSamazonka-cognito-idp
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CognitoIdentityProvider.Types.UserType

Description

 
Synopsis

Documentation

data UserType Source #

The user type.

See: newUserType smart constructor.

Constructors

UserType' 

Fields

  • enabled :: Maybe Bool

    Specifies whether the user is enabled.

  • userStatus :: Maybe UserStatusType

    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.
    • RESET_REQUIRED - User is confirmed, but the user must request a code and reset his or her password before he or she 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 his or her password to a new value before doing anything else.
  • username :: Maybe (Sensitive Text)

    The user name of the user you wish to describe.

  • userCreateDate :: Maybe POSIX

    The creation date of the user.

  • attributes :: Maybe [AttributeType]

    A container with information about the user type attributes.

  • mfaOptions :: Maybe [MFAOptionType]

    The MFA options for the user.

  • userLastModifiedDate :: Maybe POSIX

    The last modified date of the user.

Instances

Instances details
Eq UserType Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.Types.UserType

Show UserType Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.Types.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 #

NFData UserType Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.Types.UserType

Methods

rnf :: UserType -> () #

Hashable UserType Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.Types.UserType

Methods

hashWithSalt :: Int -> UserType -> Int #

hash :: UserType -> Int #

FromJSON UserType Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.Types.UserType

type Rep UserType Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.Types.UserType

type Rep UserType = D1 ('MetaData "UserType" "Amazonka.CognitoIdentityProvider.Types.UserType" "libZSservicesZSamazonka-cognito-idpZSamazonka-cognito-idp" 'False) (C1 ('MetaCons "UserType'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "userStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserStatusType)) :*: S1 ('MetaSel ('Just "username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))))) :*: ((S1 ('MetaSel ('Just "userCreateDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AttributeType]))) :*: (S1 ('MetaSel ('Just "mfaOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MFAOptionType])) :*: S1 ('MetaSel ('Just "userLastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))))

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:enabled:UserType', userType_enabled - Specifies whether the user is enabled.

$sel:userStatus:UserType', userType_userStatus - 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.
  • RESET_REQUIRED - User is confirmed, but the user must request a code and reset his or her password before he or she 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 his or her password to a new value before doing anything else.

$sel:username:UserType', userType_username - The user name of the user you wish to describe.

$sel:userCreateDate:UserType', userType_userCreateDate - The creation date of the user.

$sel:attributes:UserType', userType_attributes - A container with information about the user type attributes.

$sel:mfaOptions:UserType', userType_mfaOptions - The MFA options for the user.

$sel:userLastModifiedDate:UserType', userType_userLastModifiedDate - The last modified date of the user.

userType_enabled :: Lens' UserType (Maybe Bool) Source #

Specifies whether the user is enabled.

userType_userStatus :: Lens' UserType (Maybe UserStatusType) Source #

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.
  • RESET_REQUIRED - User is confirmed, but the user must request a code and reset his or her password before he or she 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 his or her password to a new value before doing anything else.

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

The user name of the user you wish to describe.

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

The creation date of the user.

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.