AWSCognitoIdentityProviderAdminGetUserResponse

@interface AWSCognitoIdentityProviderAdminGetUserResponse

Represents the response from the server from the request to get the specified user as an administrator.

Required parameters: [Username]

  • Indicates that the status is enabled.

    Declaration

    Objective-C

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

    Swift

    var enabled: NSNumber? { get set }
  • This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn’t provide information about TOTP software token MFA configurations. To look up information about either type of MFA configuration, use the AdminGetUserResponse$UserMFASettingList response instead.

    Declaration

    Objective-C

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

    Swift

    var mfaOptions: [AWSCognitoIdentityProviderMFAOptionType]? { get set }
  • The user’s preferred MFA setting.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) NSString *_Nullable preferredMfaSetting;

    Swift

    var preferredMfaSetting: String? { get set }
  • An array of name-value pairs representing user attributes.

    Declaration

    Objective-C

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

    Swift

    var userAttributes: [AWSCognitoIdentityProviderAttributeType]? { get set }
  • The date the user was created.

    Declaration

    Objective-C

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

    Swift

    var userCreateDate: Date? { get set }
  • The date the user was last modified.

    Declaration

    Objective-C

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

    Swift

    var userLastModifiedDate: Date? { get set }
  • The MFA options that are enabled for the user. The possible values in this list are SMS_MFA and SOFTWARE_TOKEN_MFA.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic)
        NSArray<NSString *> *_Nullable userMFASettingList;

    Swift

    var userMFASettingList: [String]? { get set }
  • 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.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic)
        AWSCognitoIdentityProviderUserStatusType userStatus;

    Swift

    var userStatus: AWSCognitoIdentityProviderUserStatusType { get set }
  • The user name of the user about whom you are receiving information.

    Declaration

    Objective-C

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

    Swift

    var username: String? { get set }