AWSCognitoIdentityProviderAdminGetUserResponse

Objective-C

@interface AWSCognitoIdentityProviderAdminGetUserResponse

Swift

class 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 (nonatomic, strong) 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 time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.

    Declaration

    Objective-C

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

    Swift

    var mfaOptions: [AWSCognitoIdentityProviderMFAOptionType]? { get set }

  • The user’s preferred MFA setting.

    Declaration

    Objective-C

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

    Swift

    var preferredMfaSetting: String? { get set }

  • An array of name-value pairs representing user attributes.

    Declaration

    Objective-C

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

    Swift

    var userAttributes: [AWSCognitoIdentityProviderAttributeType]? { get set }

  • The date the user was created.

    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 MFA options that are activated for the user. The possible values in this list are SMS_MFA and SOFTWARE_TOKEN_MFA.

    Declaration

    Objective-C

    @property (nonatomic, strong) 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.

    • 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 username of the user that you requested.

    Declaration

    Objective-C

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

    Swift

    var username: String? { get set }