AWSCognitoIdentityProviderUserType

Objective-C

@interface AWSCognitoIdentityProviderUserType

Swift

class AWSCognitoIdentityProviderUserType

A user profile in a Amazon Cognito user pool.

  • A container with information about the user type attributes.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSCognitoIdentityProviderAttributeType *> *_Nullable attributes;

    Swift

    var attributes: [AWSCognitoIdentityProviderAttributeType]? { get set }

  • Specifies whether the user is enabled.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable enabled;

    Swift

    var enabled: NSNumber? { get set }

  • The MFA options for the user.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSCognitoIdentityProviderMFAOptionType *> *_Nullable MFAOptions;

    Swift

    var mfaOptions: [AWSCognitoIdentityProviderMFAOptionType]? { get set }

  • The creation date of the user.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable userCreateDate;

    Swift

    var userCreateDate: Date? { get set }

  • 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 Date object.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable userLastModifiedDate;

    Swift

    var userLastModifiedDate: Date? { get set }

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

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

    Declaration

    Objective-C

    @property (nonatomic) AWSCognitoIdentityProviderUserStatusType userStatus;

    Swift

    var userStatus: AWSCognitoIdentityProviderUserStatusType { get set }

  • The user name of the user you want to describe.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable username;

    Swift

    var username: String? { get set }