Class UserController

The UserController class provides Business Layer methods for Users.

Inheritance

System.Object

ServiceLocator<IUserController, UserController>

UserController

Implements

IUserController

Inherited Members

ServiceLocator<IUserController, UserController>.Instance

ServiceLocator<IUserController, UserController>.Factory

ServiceLocator<IUserController, UserController>.SetTestableInstance(IUserController)

ServiceLocator<IUserController, UserController>.ClearInstance()

ServiceLocator<IUserController, UserController>.GetFactory()

Namespace: DotNetNuke.Entities.Users

Assembly: DotNetNuke.dll

Syntax

public class UserController : ServiceLocator<IUserController, UserController>, IUserController

Remarks

DotNetNuke user management is base on asp.net membership provider, but the default implementation of these providers do not satisfy the broad set of use cases which we need to support in DotNetNuke. so The dependency of DotNetNuke on the MemberRole (ASP.NET 2 Membership) components will be abstracted into a DotNetNuke Membership Provider, in order to allow developers complete flexibility in implementing alternate Membership approaches.

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

Properties

| Improve this Doc View Source

DisplayFormat

Gets or sets the display name format with support for replacing some tokens.

Declaration

public string DisplayFormat { get; set; }

Property Value

Type	Description
System.String

Remarks

Valid tokens are: [USERID], [FIRSTNAME], [LASTNAME] and [USERNAME].

PortalId

Gets or sets the site (portal) id.

Declaration

public int PortalId { get; set; }

Property Value

Type	Description
System.Int32

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

Methods

| Improve this Doc View Source

AddUserPortal(Int32, Int32)

add new userportal record (used for creating sites with existing user).

Declaration

public static void AddUserPortal(int portalId, int userId)

Parameters

Type	Name	Description
System.Int32	portalId	portalid.
System.Int32	userId	userid.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

ApproveUser(UserInfo)

ApproveUser removes the Unverified Users role from the user and adds the auto assigned roles.

Declaration

public static void ApproveUser(UserInfo user)

Parameters

Type	Name	Description
UserInfo	user	The user to update.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

ChangePassword(UserInfo, String, String)

Attempts to change the users password.

Declaration

public static bool ChangePassword(UserInfo user, string oldPassword, string newPassword)

Parameters

Type	Name	Description
UserInfo	user	The user to update.
System.String	oldPassword	The old password.
System.String	newPassword	The new password.

Returns

Type	Description
System.Boolean	A Boolean indicating success or failure.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

ChangePasswordByToken(Int32, String, String, String, String, out String)

Validates the password reset token and changes the password if valid.

Declaration

public static bool ChangePasswordByToken(int portalid, string username, string newPassword, string answer, string resetToken, out string errorMessage)

Parameters

Type	Name	Description
System.Int32	portalid	The site (portal) id where the user exists.
System.String	username	The username of the user to change the password for.
System.String	newPassword	The new password.
System.String	answer	The password reset question/answer answer.
System.String	resetToken	The password reset token, typically supplied through a password reset email.
System.String	errorMessage	If the attempt fails, this parameter will contain the reason.

Returns

Type	Description
System.Boolean	A Boolean indicating success or failure.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

ChangePasswordByToken(Int32, String, String, String, out String)

overload will validate the token and if valid change the password it does not require an old password as it supports hashed passwords errorMessage will define why reset failed.

Declaration

public static bool ChangePasswordByToken(int portalid, string username, string newPassword, string resetToken, out string errorMessage)

Parameters

Type	Name	Description
System.Int32	portalid
System.String	username
System.String	newPassword	The new password.
System.String	resetToken	The reset token, typically supplied through a password reset email.
System.String	errorMessage

Returns

Type	Description
System.Boolean	A Boolean indicating success or failure.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

ChangePasswordByToken(Int32, String, String, String)

Validates the password reset token and if valid changes the password.

Declaration

public static bool ChangePasswordByToken(int portalid, string username, string newPassword, string resetToken)

Parameters

Type	Name	Description
System.Int32	portalid	The site (portal) id on which the user exists.
System.String	username	The username of the user to change the password for.
System.String	newPassword	The new password.
System.String	resetToken	The reset token, typically supplied through a password reset email.

Returns

Type	Description
System.Boolean	A Boolean indicating whether the password change succeeded.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

ChangePasswordQuestionAndAnswer(UserInfo, String, String, String)

Attempts to change the users password reset question and answer.

Declaration

public static bool ChangePasswordQuestionAndAnswer(UserInfo user, string password, string passwordQuestion, string passwordAnswer)

Parameters

Type	Name	Description
UserInfo	user	The user to update.
System.String	password	The password.
System.String	passwordQuestion	The new password question.
System.String	passwordAnswer	The new password answer.

Returns

Type	Description
System.Boolean	A Boolean indicating success or failure.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

ChangeUsername(Int32, String)

update username in the system works around membershipprovider limitation.

Declaration

public static void ChangeUsername(int userId, string newUsername)

Parameters

Type	Name	Description
System.Int32	userId	user id.
System.String	newUsername	new one.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

CheckInsecurePassword(String, String, ref UserLoginStatus)

Checks if the user has known default username and password.

Declaration

public static void CheckInsecurePassword(string username, string password, ref UserLoginStatus loginStatus)

Parameters

Type	Name	Description
System.String	username	The user username.
System.String	password	The user password.
UserLoginStatus	loginStatus	If a known default username and password is used, will return LOGIN_INSECUREADMINPASSWORD or LOGIN_INSECUREHOSTPASSWORD.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

CopyUserToPortal(UserInfo, PortalInfo, Boolean, Boolean)

The UserController class provides Business Layer methods for Users.

Declaration

public static void CopyUserToPortal(UserInfo user, PortalInfo portal, bool mergeUser, bool deleteUser)

Parameters

Type	Name	Description
UserInfo	user
PortalInfo	portal
System.Boolean	mergeUser
System.Boolean	deleteUser

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

CopyUserToPortal(UserInfo, PortalInfo, Boolean)

Copys a user to a different portal.

Declaration

public static void CopyUserToPortal(UserInfo user, PortalInfo destinationPortal, bool mergeUser)

Parameters

Type	Name	Description
UserInfo	user	The user to copy.
PortalInfo	destinationPortal	The destination portal.
System.Boolean	mergeUser	A flag that indicates whether to merge the original user.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

CreateUser(ref UserInfo, Boolean)

Creates a new User in the Data Store optionally sending an email notification.

Declaration

public static UserCreateStatus CreateUser(ref UserInfo user, bool sendEmailNotification)

Parameters

Type	Name	Description
UserInfo	user	The UserInfo object to persist to the Database.
System.Boolean	sendEmailNotification	A value indicating whether a registration email will be sent to user.

Returns

Type	Description
UserCreateStatus	The UserCreateStatus of the User.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

CreateUser(ref UserInfo)

Creates a new User in the Data Store.

Declaration

public static UserCreateStatus CreateUser(ref UserInfo user)

Parameters

Type	Name	Description
UserInfo	user	The userInfo object to persist to the Database.

Returns

Type	Description
UserCreateStatus	The UserCreateStatus ot the User.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

DeleteUnauthorizedUsers(Int32)

Deletes all Unauthorized Users for a Portal.

Declaration

public static void DeleteUnauthorizedUsers(int portalId)

Parameters

Type	Name	Description
System.Int32	portalId	The Id of the Portal.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

DeleteUser(ref UserInfo, Boolean, Boolean)

Deletes an existing User from the Data Store.

Declaration

public static bool DeleteUser(ref UserInfo user, bool notify, bool deleteAdmin)

Parameters

Type	Name	Description
UserInfo	user	The userInfo object to delete from the Database.
System.Boolean	notify	A flag that indicates whether an email notification should be sent.
System.Boolean	deleteAdmin	A flag that indicates whether the Portal Administrator should be deleted.

Returns

Type	Description
System.Boolean	A Boolean value that indicates whether the User was successfully deleted.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

DeleteUsers(Int32, Boolean, Boolean)

Deletes all Users for a Portal.

Declaration

public static void DeleteUsers(int portalId, bool notify, bool deleteAdmin)

Parameters

Type	Name	Description
System.Int32	portalId	The Id of the Portal.
System.Boolean	notify	A flag that indicates whether an email notification should be sent.
System.Boolean	deleteAdmin	A flag that indicates whether the Portal Administrator should be deleted.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

FillUserInfo(Int32, IDataReader, Boolean)

The UserController class provides Business Layer methods for Users.

Declaration

public static UserInfo FillUserInfo(int portalId, IDataReader dr, bool closeDataReader)

Parameters

Type	Name	Description
System.Int32	portalId
IDataReader	dr
System.Boolean	closeDataReader

Returns

Type	Description
UserInfo

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

GeneratePassword()

Generates a new random password.

Declaration

public static string GeneratePassword()

Returns

Type	Description
System.String	A string representing the randomly generated password which is the minimum password length + 4 characters.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

GeneratePassword(Int32)

Generates a new random password.

Declaration

public static string GeneratePassword(int length)

Parameters

Type	Name	Description
System.Int32	length	The length of password to generate.

Returns

Type	Description
System.String	A string representing the newly generated random password.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

GetCachedUser(Int32, String)

Retrieves the User from the Cache, or fetches a fresh copy if not in cache or if Cache settings are not set to HeavyCaching.

Declaration

public static UserInfo GetCachedUser(int portalId, string username)

Parameters

Type	Name	Description
System.Int32	portalId	The Id of the Portal.
System.String	username	The username of the user being retrieved.

Returns

Type	Description
UserInfo	The user as a UserInfo object.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

GetCurrentUserInfo()

The UserController class provides Business Layer methods for Users.

Declaration

public static UserInfo GetCurrentUserInfo()

Returns

Type	Description
UserInfo

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

GetDefaultUserSettings()

Gets a set of default portal settings relative to user management.

Declaration

public static Hashtable GetDefaultUserSettings()

Returns

Type	Description
Hashtable	A or the user related portal settings.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

GetDeletedUsers(Int32)

Gets deleted users for a portal.

Declaration

public static ArrayList GetDeletedUsers(int portalId)

Parameters

Type	Name	Description
System.Int32	portalId	The portal id for which to get the deleted users.

Returns

Type	Description
ArrayList	An ArrayList of UserInfo.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

GetDuplicateEmailCount()

Gets the number count for all duplicate e-mail adresses in the database.

Declaration

public static int GetDuplicateEmailCount()

Returns

Type	Description
System.Int32	An integer representing the amount of duplicate emails.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

GetFactory()

Gets a new UserController instance.

Declaration

protected override Func<IUserController> GetFactory()

Returns

Type	Description
Func<IUserController>	A new instance of the UserController class.

Overrides

DotNetNuke.Framework.ServiceLocator<DotNetNuke.Entities.Users.IUserController, DotNetNuke.Entities.Users.UserController>.GetFactory()

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

GetOnlineUsers(Int32)

Gets a collection of Online Users.

Declaration

public static ArrayList GetOnlineUsers(int portalId)

Parameters

Type	Name	Description
System.Int32	portalId	The Id of the Portal.

Returns

Type	Description
ArrayList	An ArrayList of UserInfo objects.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

GetPassword(ref UserInfo, String)

Gets the Current Password Information for the User.

Declaration

public static string GetPassword(ref UserInfo user, string passwordAnswer)

Parameters

Type	Name	Description
UserInfo	user	The user whose Password information we are retrieving.
System.String	passwordAnswer	The answer to the user's password Question.

Returns

Type	Description
System.String	A string representing the user password.

Remarks

This method will only return the password if the memberProvider supports and is using a password encryption method that supports decryption.

GetProfileAvatarAbsoluteUrl(Int32, UserInfo, Int32, Int32, Boolean)

Returns a absolute URL for the user profile image while removing that of the deleted and super users.

Declaration

public static string GetProfileAvatarAbsoluteUrl(int portalId, UserInfo user, int width = 64, int height = 64, bool showSuperUsers = true)

Parameters

Type	Name	Description
System.Int32	portalId	The site (portal) id.
UserInfo	user	The user to get the profile image from.
System.Int32	width	Width in pixels.
System.Int32	height	Height in pixels.
System.Boolean	showSuperUsers	A value indicating whether to get the profile picture for SuperUsers (Hosts).

Returns

Type	Description
System.String	Absolute user profile picture url.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

GetUnAuthorizedUsers(Int32, Boolean, Boolean)

Gets the unauthorized users for a portal.

Declaration

public static ArrayList GetUnAuthorizedUsers(int portalId, bool includeDeleted, bool superUsersOnly)

Parameters

Type	Name	Description
System.Int32	portalId	The site (portal) id on which to search for Unauthorized users.
System.Boolean	includeDeleted	A value indicating whether to include deleted users.
System.Boolean	superUsersOnly	A value indicating whether to include superusers (hosts).

Returns

Type	Description
ArrayList	An ArrayList of UserInfo.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

GetUnAuthorizedUsers(Int32)

Gets all the users of the portal, that are not authorized.

Declaration

public static ArrayList GetUnAuthorizedUsers(int portalId)

Parameters

Type	Name	Description
System.Int32	portalId	The Id of the site (portal).

Returns

Type	Description
ArrayList	An ArrayList of UserInfo objects.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

GetUser(Int32, Int32)

Gets a specific user information.

Declaration

public UserInfo GetUser(int portalId, int userId)

Parameters

Type	Name	Description
System.Int32	portalId	The site (portal) id on which to get the user from.
System.Int32	userId	The user id to get the information for.

Returns

Type	Description
UserInfo	A UserInfo instance or null.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

GetUserByDisplayname(Int32, String)

Get a user based on their display name and portal.

Declaration

public UserInfo GetUserByDisplayname(int portalId, string displayName)

Parameters

Type	Name	Description
System.Int32	portalId	The portal ID.
System.String	displayName	The display name.

Returns

Type	Description
UserInfo	A UserInfo instance or null.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

GetUserByEmail(Int32, String)

Gets one single user matching the email address provided, this will only return the first match found. This will only be useful in portals without duplicate email addresses.

Declaration

public static UserInfo GetUserByEmail(int portalId, string emailToMatch)

Parameters

Type	Name	Description
System.Int32	portalId	The id of the site (portal).
System.String	emailToMatch	The email address to use to find a match.

Returns

Type	Description
UserInfo	A single UserInfo object or null if no user found.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

GetUserById(Int32, Int32)

Retrieves a User from the DataStore.

Declaration

public static UserInfo GetUserById(int portalId, int userId)

Parameters

Type	Name	Description
System.Int32	portalId	The ID of the Portal.
System.Int32	userId	The ID of the user being retrieved from the Data Store.

Returns

Type	Description
UserInfo	A UserInfo instance or null.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

GetUserByName(Int32, String)

Gets a user from the DataStore.

Declaration

public static UserInfo GetUserByName(int portalId, string username)

Parameters

Type	Name	Description
System.Int32	portalId	The id of the site (portal).
System.String	username	The username of the user being retrieved from the Data Store.

Returns

Type	Description
UserInfo	The User as a UserInfo object.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

GetUserByName(String)

Gets a User from the DataStore.

Declaration

public static UserInfo GetUserByName(string username)

Parameters

Type	Name	Description
System.String	username	The username of the user being retrieved from the Data Store.

Returns

Type	Description
UserInfo	The User as a UserInfo object.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

GetUserByPasswordResetToken(Int32, String)

Gets a single user by its password reset token.

Declaration

public static UserInfo GetUserByPasswordResetToken(int portalId, string resetToken)

Parameters

Type	Name	Description
System.Int32	portalId	The site (portal) id for the user.
System.String	resetToken	the password reset token.

Returns

Type	Description
UserInfo	A user represented in a UserInfo object.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

GetUserByVanityUrl(Int32, String)

Gets a user by its vanity url.

Declaration

public static UserInfo GetUserByVanityUrl(int portalId, string vanityUrl)

Parameters

Type	Name	Description
System.Int32	portalId	The site (portal) id of the user.
System.String	vanityUrl	The vanity url to search.

Returns

Type	Description
UserInfo	A user as a UserInfo object.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

GetUserCountByPortal(Int32)

Gets the number of users in a site (portal).

Declaration

public static int GetUserCountByPortal(int portalId)

Parameters

Type	Name	Description
System.Int32	portalId	The id of the portal to search.

Returns

Type	Description
System.Int32	The no of users the portal contains.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

GetUserCreateStatus(UserCreateStatus)

Gets a localized string representing the user creation status.

Declaration

public static string GetUserCreateStatus(UserCreateStatus userRegistrationStatus)

Parameters

Type	Name	Description
UserCreateStatus	userRegistrationStatus	The user creation status as a UserCreateStatus.

Returns

Type	Description
System.String	A localized string representing the user creation status.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

GetUserMembership(UserInfo)

Gets the membership information for a user.

Declaration

public static void GetUserMembership(UserInfo user)

Parameters

Type	Name	Description
UserInfo	user	The user whose membership information to retrieve.

Remarks

This method does not return the membership information, it populates it inside the UserInfo object.

GetUserProfilePictureUrl(Int32, Int32, Int32, Int32)

Gets the (relative) URL to the given user's profile picture in the given portal.

Declaration

public string GetUserProfilePictureUrl(int portalId, int userId, int width, int height)

Parameters

Type	Name	Description
System.Int32	portalId	Portal ID.
System.Int32	userId	User ID.
System.Int32	width	Width in pixels.
System.Int32	height	Height in pixels.

Returns

Type	Description
System.String	Relative URL, e.g. `/DnnImageHandler.ashx?userid=1&h=32&w=32`, considering child portal.

Remarks

IMPORTANT NOTE: this overloaded method does not depend on the current portal setting so it can be used in background threads or scheduler jobs.

GetUserProfilePictureUrl(Int32, Int32, Int32)

Gets the (relative) URL to the given user's profile picture in the current portal.

Declaration

public string GetUserProfilePictureUrl(int userId, int width, int height)

Parameters

Type	Name	Description
System.Int32	userId	User ID.
System.Int32	width	Width in pixels.
System.Int32	height	Height in pixels.

Returns

Type	Description
System.String	Relative URL, e.g. `/DnnImageHandler.ashx?userid=1&h=32&w=32`, considering child portal.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

GetUsers(Boolean, Boolean, Int32)

Gets the users of a given portal.

Declaration

public static ArrayList GetUsers(bool includeDeleted, bool superUsersOnly, int portalId)

Parameters

Type	Name	Description
System.Boolean	includeDeleted	A value indicating whether to include deleted users.
System.Boolean	superUsersOnly	A value indicating whether to ONLY include SuperUsers (Hosts).
System.Int32	portalId	The id of the site (portal).

Returns

Type	Description
ArrayList	An ArrayList of UserInfo objects.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

GetUsers(Int32, Int32, Int32, ref Int32, Boolean, Boolean)

Gets all the users of a given portal, by page.

Declaration

public static ArrayList GetUsers(int portalId, int pageIndex, int pageSize, ref int totalRecords, bool includeDeleted, bool superUsersOnly)

Parameters

Type	Name	Description
System.Int32	portalId	The id of the site (portal).
System.Int32	pageIndex	The page of records to return.
System.Int32	pageSize	The size of each page.
System.Int32	totalRecords	The total number of records.
System.Boolean	includeDeleted	A value indicating whether to include deleted users.
System.Boolean	superUsersOnly	A value indicating whether to ONLY include superUsers (Hosts).

Returns

Type	Description
ArrayList	An ArrayList of UserInfo objects.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

GetUsers(Int32, Int32, Int32, ref Int32)

Gets all the users of a given portal, excluding deleted users and SuperUsers (Hosts), by page.

Declaration

public static ArrayList GetUsers(int portalId, int pageIndex, int pageSize, ref int totalRecords)

Parameters

Type	Name	Description
System.Int32	portalId	The id of the site (portal).
System.Int32	pageIndex	The page of records to return.
System.Int32	pageSize	The size of each page.
System.Int32	totalRecords	The total number of records.

Returns

Type	Description
ArrayList	An ArrayList of UserInfo objects.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

GetUsers(Int32)

Gets all the users of a given portal.

Declaration

public static ArrayList GetUsers(int portalId)

Parameters

Type	Name	Description
System.Int32	portalId	The id of the site (portal).

Returns

Type	Description
ArrayList	An ArrayList of UserInfo objects.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

GetUsersAdvancedSearch(Int32, Int32, Int32, Int32, Int32, Boolean, Int32, Int32, String, Boolean, String, String)

Searches for users via user fields and profile properties.

Declaration

public IList<UserInfo> GetUsersAdvancedSearch(int portalId, int userId, int filterUserId, int filterRoleId, int relationTypeId, bool isAdmin, int pageIndex, int pageSize, string sortColumn, bool sortAscending, string propertyNames, string propertyValues)

Parameters

Type	Name	Description
System.Int32	portalId	The portal ID in which to search for users.
System.Int32	userId	The ID of the user searching. This is used to determine access to view profile properties. Can be to get anonymous results.
System.Int32	filterUserId	The ID of a user with whom the resulting user must have a relationship. Only applies if `relationTypeId` is supplied. Can be for no filter.
System.Int32	filterRoleId	The ID of a role which the resulting user must hold. Can be for no filter.
System.Int32	relationTypeId	The ID of a relationship type by which the resulting user and the `filterUserId` are related. Can be for no filter.
System.Boolean	isAdmin	Whether the requesting user is an admin (i.e. whether they can view admin-only profile properties).
System.Int32	pageIndex	The 0-based page index.
System.Int32	pageSize	The number of results to return in each page.
System.String	sortColumn	The name of the column/property to sort by. Sorts by if not supplied.
System.Boolean	sortAscending	Whether the sort is ascending or descending.
System.String	propertyNames	A comma-delimited list of property names (e.g. `"Username,Street1"`).
System.String	propertyValues	A comma-delimited list of property values (e.g. `"jane,123 Street"`).

Returns

Type	Description
IList<UserInfo>	A list of UserInfo instances.

Remarks

All property values must match for a result to be included (i.e. this is an AND search).

GetUsersBasicSearch(Int32, Int32, Int32, String, Boolean, String, String)

Searches for users via a user property.

Declaration

public IList<UserInfo> GetUsersBasicSearch(int portalId, int pageIndex, int pageSize, string sortColumn, bool sortAscending, string propertyName, string propertyValue)

Parameters

Type	Name	Description
System.Int32	portalId	The portal ID in which to search for users.
System.Int32	pageIndex	The 0-based page index.
System.Int32	pageSize	The number of results to return in each page.
System.String	sortColumn	The name of the column/property to sort by. Sorts by if not supplied.
System.Boolean	sortAscending	Whether the sort is ascending or descending.
System.String	propertyName	A property name (i.e. a column from `vw_Users`, for example `"Username"`, `"DisplayName"` or `"Email"`).
System.String	propertyValue	The value to search by, results will contain this text in the property.

Returns

Type	Description
IList<UserInfo>	A list of UserInfo instances.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

GetUsersByDisplayName(Int32, String, Int32, Int32, ref Int32, Boolean, Boolean)

Gets all the users of the portal whose display name matches a provided filter expression, by page.

Declaration

public static ArrayList GetUsersByDisplayName(int portalId, string nameToMatch, int pageIndex, int pageSize, ref int totalRecords, bool includeDeleted, bool superUsersOnly)

Parameters

Type	Name	Description
System.Int32	portalId	The id of the site (portal).
System.String	nameToMatch	The display name to use to find a match.
System.Int32	pageIndex	The page of records to return.
System.Int32	pageSize	The size of each page.
System.Int32	totalRecords	The total number of records that satisfy the criteria.
System.Boolean	includeDeleted	A value indicating whether to include deleted users.
System.Boolean	superUsersOnly	A value indicating whether to ONLY inlude SuperUsers (Hosts).

Returns

Type	Description
ArrayList	An ArrayList of UserInfo objects.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

GetUsersByEmail(Int32, String, Int32, Int32, ref Int32, Boolean, Boolean)

Gets all the users of the portal whose email matches a provided filter expression.

Declaration

public static ArrayList GetUsersByEmail(int portalId, string emailToMatch, int pageIndex, int pageSize, ref int totalRecords, bool includeDeleted, bool superUsersOnly)

Parameters

Type	Name	Description
System.Int32	portalId	The id of the site (portal).
System.String	emailToMatch	The email address to use to find a match.
System.Int32	pageIndex	The page of records to return.
System.Int32	pageSize	The size of each page.
System.Int32	totalRecords	The total number of records that satisfy the criteria.
System.Boolean	includeDeleted	A value indicating whether to include deleted users.
System.Boolean	superUsersOnly	A value indicating if the search should ONLY include SuperUsers (Hosts).

Returns

Type	Description
ArrayList	An ArrayList of UserInfo objects.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

GetUsersByEmail(Int32, String, Int32, Int32, ref Int32)

Gets all the users of a given portal whose email matches a provided filter, excluding deleted users and SuperUsers (Hosts).

Declaration

public static ArrayList GetUsersByEmail(int portalId, string emailToMatch, int pageIndex, int pageSize, ref int totalRecords)

Parameters

Type	Name	Description
System.Int32	portalId	The id of the site (portal).
System.String	emailToMatch	The email address to use to find a match.
System.Int32	pageIndex	The page of records to return.
System.Int32	pageSize	The size of each page.
System.Int32	totalRecords	The total number of records that satisfy the criteria.

Returns

Type	Description
ArrayList	An ArrayList of UserInfo objects.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

GetUsersByProfileProperty(Int32, String, String, Int32, Int32, ref Int32, Boolean, Boolean)

Gets all the users of the portal whose profile matches the profile property pased as a parameter.

Declaration

public static ArrayList GetUsersByProfileProperty(int portalId, string propertyName, string propertyValue, int pageIndex, int pageSize, ref int totalRecords, bool includeDeleted, bool superUsersOnly)

Parameters

Type	Name	Description
System.Int32	portalId	The id of the site (portal).
System.String	propertyName	The name of the property being matched.
System.String	propertyValue	The value of the property being matched.
System.Int32	pageIndex	The page of records to return.
System.Int32	pageSize	The size of each page.
System.Int32	totalRecords	The total number of records that satisfy the criteria.
System.Boolean	includeDeleted	A value indicating whether to include deleted users.
System.Boolean	superUsersOnly	A value indicating whether to ONLY include SuperUsers (Hosts).

Returns

Type	Description
ArrayList	An ArrayList of UserInfo objects.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

GetUsersByProfileProperty(Int32, String, String, Int32, Int32, ref Int32)

Gets all the users of the portal whose profile matches the profile property pased as a parameter.

Declaration

public static ArrayList GetUsersByProfileProperty(int portalId, string propertyName, string propertyValue, int pageIndex, int pageSize, ref int totalRecords)

Parameters

Type	Name	Description
System.Int32	portalId	The id of the site (portal).
System.String	propertyName	The name of the property being matched.
System.String	propertyValue	The value of the property being matched.
System.Int32	pageIndex	The page of records to return.
System.Int32	pageSize	The size of each page.
System.Int32	totalRecords	The total number of records that satisfy the criteria.

Returns

Type	Description
ArrayList	An ArrayList of UserInfo objects.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

GetUsersByUserName(Int32, String, Int32, Int32, ref Int32, Boolean, Boolean)

Gets all the users of the portal whose username matches a provided filter expression, by page.

Declaration

public static ArrayList GetUsersByUserName(int portalId, string userNameToMatch, int pageIndex, int pageSize, ref int totalRecords, bool includeDeleted, bool superUsersOnly)

Parameters

Type	Name	Description
System.Int32	portalId	The id of the site (portal).
System.String	userNameToMatch	The username to use to find a match.
System.Int32	pageIndex	The page of records to return.
System.Int32	pageSize	The size of each page.
System.Int32	totalRecords	The total number of records that satisfy the criteria.
System.Boolean	includeDeleted	A value indicating whether to include deleted users.
System.Boolean	superUsersOnly	A value indicating whether to ONLY include SuperUsers (Hosts).

Returns

Type	Description
ArrayList	An ArrayList of UserInfo objects.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

GetUsersByUserName(Int32, String, Int32, Int32, ref Int32)

Gets all the users of the portal whose username matches a provided filter expression, excluding deleted users and SuperUsers (Hosts), by page.

Declaration

public static ArrayList GetUsersByUserName(int portalId, string userNameToMatch, int pageIndex, int pageSize, ref int totalRecords)

Parameters

Type	Name	Description
System.Int32	portalId	The id of the site (portal).
System.String	userNameToMatch	The username to use to find a match.
System.Int32	pageIndex	The page of records to return.
System.Int32	pageSize	The size of each page.
System.Int32	totalRecords	The total number of records that satisfy the criteria.

Returns

Type	Description
ArrayList	An ArrayList of UserInfo objects.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

GetUserSettings(Int32)

Gets the user related portal settings.

Declaration

public static Hashtable GetUserSettings(int portalId)

Parameters

Type	Name	Description
System.Int32	portalId	The id of the site (portal).

Returns

Type	Description
Hashtable	The Settings Hashtable.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

IsValidUserName(String)

Check if userName is a valid username.

Declaration

public bool IsValidUserName(string userName)

Parameters

Type	Name	Description
System.String	userName	The username to check.

Returns

Type	Description
System.Boolean	true is the `userName` is valid, false if invalid.

Remarks

Checks the userName against the following rules:

Invalid characters (based on a host setting or ).
Length check for 5 chars
It must not start or end with space

MoveUserToPortal(UserInfo, PortalInfo, Boolean)

Moves a user to a different site (portal).

Declaration

public static void MoveUserToPortal(UserInfo user, PortalInfo portal, bool mergeUser)

Parameters

Type	Name	Description
UserInfo	user	The user to move.
PortalInfo	portal	The destination site (portal).
System.Boolean	mergeUser	A indicating whether to merge the basic user properties if the user already exists on the target portal.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

RemoveDeletedUsers(Int32)

Permanently removes all users marked as deleted from a portal. It will delete the membership user as well if the user is not part of other portals.

Declaration

public static void RemoveDeletedUsers(int portalId)

Parameters

Type	Name	Description
System.Int32	portalId	The id of the site (portal) on which to get the deleted users.

Remarks

In Dnn, a user can be deleted, in which case the user is just disabled or "soft deleted" but still exists in the database and can be restored. Removing a user (hard-deleting) actually removes the user information from the DataStore and cannot be undone.

RemoveUser(UserInfo)

Permanently remove a user and the associated user folder on disk. This also deletes the membership user if the user is not a member of any other portal.

Declaration

public static bool RemoveUser(UserInfo user)

Parameters

Type	Name	Description
UserInfo	user	The user to delete.

Returns

Type	Description
System.Boolean	A value indicating whether the user removal was successfull.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

ResetAndChangePassword(UserInfo, String, String)

Attempts to reset and change a user password.

Declaration

public static bool ResetAndChangePassword(UserInfo user, string oldPassword, string newPassword)

Parameters

Type	Name	Description
UserInfo	user	The user for which to change the password.
System.String	oldPassword	The user old password.
System.String	newPassword	The user new password.

Returns

Type	Description
System.Boolean	A value indicating whether the password change succeeded.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

ResetAndChangePassword(UserInfo, String)

Resets and changes the password for a user.

Declaration

public static bool ResetAndChangePassword(UserInfo user, string newPassword)

Parameters

Type	Name	Description
UserInfo	user	The user for which to change the password.
System.String	newPassword	The new password.

Returns

Type	Description
System.Boolean	A value indicating whether the password change was successfull.

Remarks

This method can only be used by admins or superusers (hosts) who do not need to supply an "old" password.

ResetPassword(UserInfo, String)

Attempts to reset the password for the specified user.

Declaration

public static string ResetPassword(UserInfo user, string passwordAnswer)

Parameters

Type	Name	Description
UserInfo	user	The user whose Password information we are resetting.
System.String	passwordAnswer	The answer to the "user's" password Question.

Returns

Type	Description
System.String	A string representing the new password.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

ResetPasswordToken(UserInfo, Boolean)

Resets the user password reset token.

Declaration

public static bool ResetPasswordToken(UserInfo user, bool sendEmail)

Parameters

Type	Name	Description
UserInfo	user	The user to reset the password reset token for.
System.Boolean	sendEmail	A value indicating whether to send a notification email to the user.

Returns

Type	Description
System.Boolean	A value indicating whether the notification email was sent or true if 'sendEmail' was false.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

ResetPasswordToken(UserInfo, Int32)

Resets the password reset token with a timeout value.

Declaration

public static void ResetPasswordToken(UserInfo user, int minutesValid)

Parameters

Type	Name	Description
UserInfo	user	The user for which to update the password reset token.
System.Int32	minutesValid	A value indication for how many minutes the generated token will be valid for.

Remarks

This method does not return anything, it updates the reset token and the token expiraiton directly in the provided UserInfo object.

ResetPasswordToken(UserInfo)

Resets the user password reset token.

Declaration

public static void ResetPasswordToken(UserInfo user)

Parameters

Type	Name	Description
UserInfo	user	The user to update the password reset token for.

Remarks

This method does not return the new token, it updates it inside the UserInfo object provided.

ResetTermsAgreement(Int32)

When called all users in the portal will need to agree to terms and conditions again.

Declaration

public static void ResetTermsAgreement(int portalId)

Parameters

Type	Name	Description
System.Int32	portalId	The portal for which to reset.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

RestoreUser(ref UserInfo)

Restores a deleted user.

Declaration

public static bool RestoreUser(ref UserInfo user)

Parameters

Type	Name	Description
UserInfo	user	The user to restore.

Returns

Type	Description
System.Boolean	A value indicating whether the user restore succeeded.

Remarks

Dnn supports deleting and restoring them. A deleted using in Dnn means a "soft-delete" or in other words disabling the user. This method can only be used for those "soft-deleted" users, if a user was removed (hard-deleted), this method cannot restore the user as that action cannot be undone.

SettingsKey(Int32)

Gets the setting key prefix for user related portal settings.

Declaration

public static string SettingsKey(int portalId)

Parameters

Type	Name	Description
System.Int32	portalId	The portal id to scope the key for.

Returns

Type	Description
System.String	A string representing the settings key for the given portal.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

UnLockUser(UserInfo)

Attempts to unlock the user's account.

Declaration

public static bool UnLockUser(UserInfo user)

Parameters

Type	Name	Description
UserInfo	user	The user whose account is being Unlocked.

Returns

Type	Description
System.Boolean	A value indicating whether the user unlock attempt succeeded.

Remarks

A user can be locked in some situations as when the user attempted too many invalid passwords.

UpdateDisplayNames()

Update all the users display names.

Declaration

public void UpdateDisplayNames()

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

UpdateUser(Int32, UserInfo, Boolean, Boolean)

Updates a user.

Declaration

public static void UpdateUser(int portalId, UserInfo user, bool loggedAction, bool sendNotification)

Parameters

Type	Name	Description
System.Int32	portalId	The id of the site (portal).
UserInfo	user	The user object.
System.Boolean	loggedAction	Whether or not the update calls the eventlog - the eventlogtype must still be enabled for logging to occur.
System.Boolean	sendNotification	Whether to send notification to the user about the update (i.e. a notification if the user was approved).

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

UpdateUser(Int32, UserInfo, Boolean)

Updates a user.

Declaration

public static void UpdateUser(int portalId, UserInfo user, bool loggedAction)

Parameters

Type	Name	Description
System.Int32	portalId	The portalid of the user to update.
UserInfo	user	The user to update.
System.Boolean	loggedAction	A value indicating whether or not the update calls the eventlog - the eventlogtype must still be enabled for logging to occur.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

UpdateUser(Int32, UserInfo)

Updates a user and logs the action.

Declaration

public static void UpdateUser(int portalId, UserInfo user)

Parameters

Type	Name	Description
System.Int32	portalId	The id of the site (portal) on which to update the user.
UserInfo	user	The use to update.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

UserAgreedToTerms(UserInfo)

User has agreed to terms and conditions. The time is recorded at the same time in SQL.

Declaration

public static void UserAgreedToTerms(UserInfo user)

Parameters

Type	Name	Description
UserInfo	user	The user that agreed.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

UserLogin(Int32, UserInfo, String, String, Boolean)

Logs a validated user in.

Declaration

public static void UserLogin(int portalId, UserInfo user, string portalName, string ip, bool createPersistentCookie)

Parameters

Type	Name	Description
System.Int32	portalId	The id of the portal the user belongs to.
UserInfo	user	The validated user.
System.String	portalName	The name of the site (portal).
System.String	ip	The IP Address of the user attempting to log in.
System.Boolean	createPersistentCookie	A value indication whether the login credentials should be persisted.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

UserLogin(Int32, String, String, String, String, String, ref UserLoginStatus, Boolean)

Validates a User's credentials against the Data Store, and sets the Forms Authentication Ticket.

Declaration

public static UserInfo UserLogin(int portalId, string username, string password, string verificationCode, string portalName, string ip, ref UserLoginStatus loginStatus, bool createPersistentCookie)

Parameters

Type	Name	Description
System.Int32	portalId	The id of the site (portal) the user belongs to.
System.String	username	The user name of the User attempting to log in.
System.String	password	The password of the User attempting to log in.
System.String	verificationCode	The verification code of the user attempting to log in.
System.String	portalName	The name of the site (portal).
System.String	ip	The IP Address of the user attempting to log in.
UserLoginStatus	loginStatus	A UserLoginStatus enumeration that indicates the status of the Login attempt. This value is returned by reference.
System.Boolean	createPersistentCookie	A flag that indicates whether the login credentials should be persisted.

Returns

Type	Description
UserInfo	The UserInfo object representing a successful login.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

UserRequestsRemoval(UserInfo, Boolean)

A user may request that their account be removed. This sets a flag on the user portal so further processing may occur manually by the site admins.

Declaration

public static void UserRequestsRemoval(UserInfo user, bool remove)

Parameters

Type	Name	Description
UserInfo	user	The user that desires to be removed.
System.Boolean	remove	A value indicating whether the user has requested removal.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

ValidatePassword(String)

Validates a password.

Declaration

public static bool ValidatePassword(string password)

Parameters

Type	Name	Description
System.String	password	The password to validate.

Returns

Type	Description
System.Boolean	A value indicating whether the password is valid.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

ValidateUser(UserInfo, Int32, Boolean)

Validates a user's password and profile.

Declaration

public static UserValidStatus ValidateUser(UserInfo objUser, int portalId, bool ignoreExpiring)

Parameters

Type	Name	Description
UserInfo	objUser	The user attempting to log in.
System.Int32	portalId	The id of the site (portal) the user belongs to.
System.Boolean	ignoreExpiring	A value indicating whether to ingore expired user.

Returns

Type	Description
UserValidStatus	The UserValidStatus that represents the outcome.

Remarks

This overload takes a valid User (credentials check out) and check whether the password and profile need updating.

ValidateUser(Int32, String, String, String, String, String, ref UserLoginStatus)

Validates a user's credentials against the Data Store.

Declaration

public static UserInfo ValidateUser(int portalId, string username, string password, string verificationCode, string portalName, string ip, ref UserLoginStatus loginStatus)

Parameters

Type	Name	Description
System.Int32	portalId	The id of the site (portal) the user belongs to.
System.String	username	The user name of the user attempting to log in.
System.String	password	The password of the user attempting to log in.
System.String	verificationCode	The verification code of the user attempting to log in.
System.String	portalName	The name of the portal.
System.String	ip	The IP address of the user attempting to log in.
UserLoginStatus	loginStatus	A UserLoginStatus enumeration that indicates the status of the Login attempt. This value is returned by reference.

Returns

Type	Description
UserInfo	The UserInfo object representing a valid user.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

ValidateUser(Int32, String, String, String, String, String, String, ref UserLoginStatus)

Validates a user's credentials against the Data Store.

Declaration

public static UserInfo ValidateUser(int portalId, string username, string password, string authType, string verificationCode, string portalName, string ip, ref UserLoginStatus loginStatus)

Parameters

Type	Name	Description
System.Int32	portalId	The id of the site (portal) the user belongs to.
System.String	username	The user name of the user attempting to log in.
System.String	password	The password of the User attempting to log in.
System.String	authType	The type of authentication used.
System.String	verificationCode	The verification code of the user attempting to log in.
System.String	portalName	The name of the site (portal).
System.String	ip	The IP Address of the user attempting to log in.
UserLoginStatus	loginStatus	A UserLoginStatus enumeration that indicates the status of the login attempt. This value is returned by reference.

Returns

Type	Description
UserInfo	The UserInfo object representing a valid user.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

VerifyUser(String)

Tries to validate a verification code sent after a user is registered in a portal configured to use a verified registration.

Declaration

public static void VerifyUser(string verificationCode)

Parameters

Type	Name	Description
System.String	verificationCode	The verification code.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

Exceptions

Type	Condition
UserAlreadyVerifiedException	Thrown when provided verification code has been already used.
InvalidVerificationCodeException	Thrown when the provided verification code is invalid.
UserDoesNotExistException	Thrown when the user does not exist.

Explicit Interface Implementations

| Improve this Doc View Source

IUserController.GetCurrentUserInfo()

Gets the current logged in user's information.

Declaration

UserInfo IUserController.GetCurrentUserInfo()

Returns

Type	Description
UserInfo	The logged in user's UserInfo object or an empty UserInfo if the current user is not logged in.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

IUserController.GetUserById(Int32, Int32)

Retrieves a User from the DataStore.

Declaration

UserInfo IUserController.GetUserById(int portalId, int userId)

Parameters

Type	Name	Description
System.Int32	portalId	The ID of the Portal.
System.Int32	userId	The ID of the user being retrieved from the Data Store.

Returns

Type	Description
UserInfo	A UserInfo instance or null.

Remarks

This will allow for a number of enhancements to be added
Removal of dependence on the HttpContext
Support for Hashed Passwords
Support for Password Question and Answer
Enforce Password Complexity
Password Aging (Expiry)
Force Password Update
Enable/Disable Password Retrieval/Reset
CAPTCHA Support
Redirect after registration/login/logout

Implements

IUserController

Extension Methods

JsonExtensionsWeb.ToJson(Object)

Class UserController

Inheritance

Implements

Inherited Members

Namespace: DotNetNuke.Entities.Users

Assembly: DotNetNuke.dll

Syntax

Remarks

Properties

DisplayFormat

Declaration

Property Value

Remarks

See Also

PortalId

Declaration

Property Value

Remarks

See Also

Methods

AddUserPortal(Int32, Int32)

Declaration

Parameters

Remarks

See Also

ApproveUser(UserInfo)

Declaration

Parameters

Remarks

See Also

ChangePassword(UserInfo, String, String)

Declaration

Parameters

Returns

Remarks

See Also

ChangePasswordByToken(Int32, String, String, String, String, out String)

Declaration

Parameters

Returns

Remarks

See Also

ChangePasswordByToken(Int32, String, String, String, out String)

Declaration

Parameters

Returns

Remarks

See Also

ChangePasswordByToken(Int32, String, String, String)

Declaration

Parameters

Returns

Remarks

See Also

ChangePasswordQuestionAndAnswer(UserInfo, String, String, String)

Declaration

Parameters

Returns

Remarks

See Also

ChangeUsername(Int32, String)

Declaration

Parameters

Remarks

See Also

CheckInsecurePassword(String, String, ref UserLoginStatus)

Declaration

Parameters

Remarks

See Also

CopyUserToPortal(UserInfo, PortalInfo, Boolean, Boolean)

Declaration

Parameters

Remarks

See Also

CopyUserToPortal(UserInfo, PortalInfo, Boolean)

Declaration

Parameters

Remarks

See Also