AWSCognitoIdentityProviderGetUserResponse

@interface AWSCognitoIdentityProviderGetUserResponse

Represents the response from the server from the request to get information about the user.

Required parameters: [Username, UserAttributes]

  • 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 use the GetUserResponse$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.

    For custom attributes, you must prepend the custom: prefix to the attribute name.

    Declaration

    Objective-C

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

    Swift

    var userAttributes: [AWSCognitoIdentityProviderAttributeType]? { 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 name of the user you wish to retrieve from the get user request.

    Declaration

    Objective-C

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

    Swift

    var username: String? { get set }