Class MembershipProvider

Inheritance

System.Object

MembershipProvider

AspNetMembershipProvider

Namespace: DotNetNuke.Security.Membership

Assembly: DotNetNuke.dll

Syntax

public abstract class MembershipProvider : object

Properties

CanEditProviderProperties

Declaration

public abstract bool CanEditProviderProperties { get; }

Property Value

Type	Description
System.Boolean

MaxInvalidPasswordAttempts

Declaration

public abstract int MaxInvalidPasswordAttempts { get; set; }

Property Value

Type	Description
System.Int32

MinNonAlphanumericCharacters

Declaration

public abstract int MinNonAlphanumericCharacters { get; set; }

Property Value

Type	Description
System.Int32

MinPasswordLength

Declaration

public abstract int MinPasswordLength { get; set; }

Property Value

Type	Description
System.Int32

PasswordAttemptWindow

Declaration

public abstract int PasswordAttemptWindow { get; set; }

Property Value

Type	Description
System.Int32

PasswordFormat

Declaration

public abstract PasswordFormat PasswordFormat { get; set; }

Property Value

Type	Description
PasswordFormat

PasswordResetEnabled

Declaration

public abstract bool PasswordResetEnabled { get; set; }

Property Value

Type	Description
System.Boolean

PasswordRetrievalEnabled

Declaration

public abstract bool PasswordRetrievalEnabled { get; set; }

Property Value

Type	Description
System.Boolean

PasswordStrengthRegularExpression

Declaration

public abstract string PasswordStrengthRegularExpression { get; set; }

Property Value

Type	Description
System.String

RequiresQuestionAndAnswer

Declaration

public abstract bool RequiresQuestionAndAnswer { get; set; }

Property Value

Type	Description
System.Boolean

RequiresUniqueEmail

Declaration

public abstract bool RequiresUniqueEmail { get; set; }

Property Value

Type	Description
System.Boolean

Methods

AddUserPortal(Int32, Int32)

Add new User-Portal record (used for creating sites with existing user).

Declaration

public virtual void AddUserPortal(int portalId, int userId)

Parameters

Type	Name	Description
System.Int32	portalId	Portal ID.
System.Int32	userId	User ID.

ChangePassword(UserInfo, String, String)

ChangePassword attempts to change the user's password.

Declaration

public abstract 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.

ChangePasswordQuestionAndAnswer(UserInfo, String, String, String)

ChangePasswordQuestionAndAnswer attempts to change the users password Question and PasswordAnswer.

Declaration

public abstract 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.

ChangeUsername(Int32, String)

function supports the ability change username.

Declaration

public virtual void ChangeUsername(int userId, string newUsername)

Parameters

Type	Name	Description
System.Int32	userId	User ID.
System.String	newUsername	updated username.

CreateUser(ref UserInfo)

CreateUser persists a User to the Data Store.

Declaration

public abstract UserCreateStatus CreateUser(ref UserInfo user)

Parameters

Type	Name	Description
UserInfo	user	The user to persist to the Data Store.

Returns

Type	Description
UserCreateStatus	A UserCreateStatus enumeration indicating success or reason for failure.

DeleteUser(UserInfo)

DeleteUser deletes a single User from the Data Store.

Declaration

public abstract bool DeleteUser(UserInfo user)

Parameters

Type	Name	Description
UserInfo	user	The user to delete from the Data Store.

Returns

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

DeleteUsersOnline(Int32)

Deletes all UserOnline info from the database that has activity outside of the time window.

Declaration

public abstract void DeleteUsersOnline(int timeWindow)

Parameters

Type	Name	Description
System.Int32	timeWindow	Time Window in Minutes.

GeneratePassword()

Generates a new random password (Length = Minimum Length + 4).

Declaration

public abstract string GeneratePassword()

Returns

Type	Description
System.String	A String.

GeneratePassword(Int32)

Generates a new random password.

Declaration

public abstract string GeneratePassword(int length)

Parameters

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

Returns

Type	Description
System.String	A String.

GetDeletedUsers(Int32)

Declaration

public abstract ArrayList GetDeletedUsers(int portalId)

Parameters

Type	Name	Description
System.Int32	portalId

Returns

Type	Description
ArrayList

GetOnlineUsers(Int32)

Gets a collection of Online Users.

Declaration

public abstract 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.

GetPassword(UserInfo, String)

Gets the Current Password Information for the User. Throws an exception if password retrieval is not supported.

Declaration

public abstract string GetPassword(UserInfo user, string passwordAnswer)

Parameters

Type	Name	Description
UserInfo	user	The user for which to get the password.
System.String	passwordAnswer	The answer to the Password Question, used to confirm the user has the right to obtain the password.

Returns

Type	Description
System.String	A String.

GetProviderUserKey(UserInfo)

Declaration

public virtual string GetProviderUserKey(UserInfo user)

Parameters

Type	Name	Description
UserInfo	user

Returns

Type	Description
System.String

GetUnAuthorizedUsers(Int32, Boolean, Boolean)

Declaration

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

Parameters

Type	Name	Description
System.Int32	portalId
System.Boolean	includeDeleted
System.Boolean	superUsersOnly

Returns

Type	Description
ArrayList

GetUnAuthorizedUsers(Int32)

Declaration

public abstract ArrayList GetUnAuthorizedUsers(int portalId)

Parameters

Type	Name	Description
System.Int32	portalId

Returns

Type	Description
ArrayList

GetUser(Int32, Int32)

GetUserByUserName retrieves a User from the DataStore.

Declaration

public abstract UserInfo GetUser(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	The User as a UserInfo object.

GetUserByAuthToken(Int32, String, String)

Declaration

public virtual UserInfo GetUserByAuthToken(int portalId, string userToken, string authType)

Parameters

Type	Name	Description
System.Int32	portalId
System.String	userToken
System.String	authType

Returns

Type	Description
UserInfo

GetUserByDisplayName(Int32, String)

Get a user based on their display name and portal.

Declaration

public virtual 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.

GetUserByPasswordResetToken(Int32, String)

GetUserByPasswordResetToken retrieves a User from the DataStore.

Declaration

public virtual UserInfo GetUserByPasswordResetToken(int portalId, string resetToken)

Parameters

Type	Name	Description
System.Int32	portalId	The Id of the Portal.
System.String	resetToken	The password reset token.

Returns

Type	Description
UserInfo	The User as a UserInfo object.

GetUserByProviderUserKey(Int32, String)

Declaration

public virtual UserInfo GetUserByProviderUserKey(int portalId, string providerUserKey)

Parameters

Type	Name	Description
System.Int32	portalId
System.String	providerUserKey

Returns

Type	Description
UserInfo

GetUserByUserName(Int32, String)

GetUserByUserName retrieves a User from the DataStore. Supports user caching in memory cache.

Declaration

public abstract UserInfo GetUserByUserName(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 from the Data Store.

Returns

Type	Description
UserInfo	The User as a UserInfo object.

GetUserByVanityUrl(Int32, String)

GetUserByVanityUrl retrieves a User from the DataStore.

Declaration

public virtual UserInfo GetUserByVanityUrl(int portalId, string vanityUrl)

Parameters

Type	Name	Description
System.Int32	portalId	The Id of the Portal.
System.String	vanityUrl	The vanityUrl of the user being retrieved from the Data Store.

Returns

Type	Description
UserInfo	The User as a UserInfo object or null.

GetUserCountByPortal(Int32)

GetUserCountByPortal gets the number of users in the portal.

Declaration

public abstract int GetUserCountByPortal(int portalId)

Parameters

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

Returns

Type	Description
System.Int32	The number of users.

GetUserMembership(ref UserInfo)

GetUserMembership retrieves the UserMembership information from the Data Store.

Declaration

public abstract void GetUserMembership(ref UserInfo user)

Parameters

Type	Name	Description
UserInfo	user	The user whose Membership information we are retrieving.

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

GetUsers gets all the users of the portal.

Declaration

public virtual 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 Portal.
System.Int32	pageIndex	The page of records to return.
System.Int32	pageSize	The size of the page.
System.Int32	totalRecords	The total number of records that satisfy the criteria.
System.Boolean	includeDeleted	Include deleted users.
System.Boolean	superUsersOnly	Only select super users.

Returns

Type	Description
ArrayList	An ArrayList of UserInfo objects.

Remarks

If all records are required, (ie no paging) set pageSize = -1.

GetUsers(Int32, Int32, Int32, ref Int32)

GetUsers gets all the users of the portal.

Declaration

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

Parameters

Type	Name	Description
System.Int32	portalId	The Id of the Portal.
System.Int32	pageIndex	The page of records to return.
System.Int32	pageSize	The size of the page.
System.Int32	totalRecords	The total no of records that satisfy the criteria.

Returns

Type	Description
ArrayList	An ArrayList of UserInfo objects.

Remarks

If all records are required, (ie no paging) set pageSize = -1.

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

Searches for users via user fields and profile properties.

Declaration

public virtual 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 virtual 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.

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

GetUsersByDisplayName gets all the users of the portal whose display name matches a provided filter expression.

Declaration

public virtual 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 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 the page.
System.Int32	totalRecords	The total number of records that satisfy the criteria.
System.Boolean	includeDeleted	Include deleted users.
System.Boolean	superUsersOnly	Only select super users.

Returns

Type	Description
ArrayList	An ArrayList of UserInfo objects.

Remarks

If all records are required, (ie no paging) set pageSize = -1.

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

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

Declaration

public virtual 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 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 the page.
System.Int32	totalRecords	The total number of records that satisfy the criteria.
System.Boolean	includeDeleted	Include deleted users.
System.Boolean	superUsersOnly	Only select super users.

Returns

Type	Description
ArrayList	An ArrayList of UserInfo objects.

Remarks

If all records are required, (ie no paging) set pageSize = -1.

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

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

Declaration

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

Parameters

Type	Name	Description
System.Int32	portalId	The Id of the 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 the page.
System.Int32	totalRecords	The total number of records that satisfy the criteria.

Returns

Type	Description
ArrayList	An ArrayList of UserInfo objects.

Remarks

If all records are required, (ie no paging) set pageSize = -1.

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

GetUsersByProfileProperty gets all the users of the portal whose profile matches the profile property passed as a parameter.

Declaration

public virtual 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 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 the page.
System.Int32	totalRecords	The total number of records that satisfy the criteria.
System.Boolean	includeDeleted	Include deleted users.
System.Boolean	superUsersOnly	Only select super users.

Returns

Type	Description
ArrayList	An ArrayList of UserInfo objects.

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

GetUsersByProfileProperty gets all the users of the portal whose profile matches the profile property passed as a parameter.

Declaration

public abstract 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 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 the page.
System.Int32	totalRecords	The total number of records that satisfy the criteria.

Returns

Type	Description
ArrayList	An ArrayList of UserInfo objects.

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

GetUsersByUserName gets all the users of the portal whose username matches a provided filter expression.

Declaration

public virtual 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 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 the page.
System.Int32	totalRecords	The total number of records that satisfy the criteria.
System.Boolean	includeDeleted	Include deleted users.
System.Boolean	superUsersOnly	Only select super users.

Returns

Type	Description
ArrayList	An ArrayList of UserInfo objects.

Remarks

If all records are required, (ie no paging) set pageSize = -1.

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

GetUsersByUserName gets all the users of the portal whose username matches a provided filter expression.

Declaration

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

Parameters

Type	Name	Description
System.Int32	portalId	The Id of the 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 the page.
System.Int32	totalRecords	The total number of records that satisfy the criteria.

Returns

Type	Description
ArrayList	An ArrayList of UserInfo objects.

Remarks

If all records are required, (ie no paging) set pageSize = -1.

Instance()

Declaration

public static MembershipProvider Instance()

Returns

Type	Description
MembershipProvider

IsUserOnline(UserInfo)

Gets whether the user in question is online.

Declaration

public abstract bool IsUserOnline(UserInfo user)

Parameters

Type	Name	Description
UserInfo	user	The user.

Returns

Type	Description
System.Boolean	A Boolean indicating whether the user is online.

RemoveUser(UserInfo)

Declaration

public abstract bool RemoveUser(UserInfo user)

Parameters

Type	Name	Description
UserInfo	user

Returns

Type	Description
System.Boolean

ResetAndChangePassword(UserInfo, String, String)

function sets user specific password reset token and timeout works for all PasswordFormats as it resets and then changes the password so old password is not required.

Declaration

public virtual bool ResetAndChangePassword(UserInfo user, string newPassword, string answer)

Parameters

Type	Name	Description
UserInfo	user	The user.
System.String	newPassword
System.String	answer

Returns

Type	Description
System.Boolean	true if the password successfully changed, otherwise false.

ResetAndChangePassword(UserInfo, String)

function sets user specific password reset token and timeout works for all PasswordFormats as it resets and then changes the password so old password is not required method does not support RequiresQuestionAndAnswer.

Declaration

public virtual bool ResetAndChangePassword(UserInfo user, string newPassword)

Parameters

Type	Name	Description
UserInfo	user	The user.
System.String	newPassword

Returns

Type	Description
System.Boolean	true if the password successfully changed, otherwise false.

ResetPassword(UserInfo, String)

ResetPassword resets a user's password and returns the newly created password.

Declaration

public abstract string ResetPassword(UserInfo user, string passwordAnswer)

Parameters

Type	Name	Description
UserInfo	user	The user to update.
System.String	passwordAnswer	The answer to the user's password Question.

Returns

Type	Description
System.String	The new Password.

ResetTermsAgreement(Int32)

Reset all agreements on portal so all users need to agree again at next login.

Declaration

public abstract void ResetTermsAgreement(int portalId)

Parameters

Type	Name	Description
System.Int32	portalId	Portal for which to reset agreements.

RestoreUser(UserInfo)

Declaration

public abstract bool RestoreUser(UserInfo user)

Parameters

Type	Name	Description
UserInfo	user

Returns

Type	Description
System.Boolean

TransferUsersToMembershipProvider()

Declaration

public virtual void TransferUsersToMembershipProvider()

UnLockUser(UserInfo)

Unlocks the User's Account.

Declaration

public abstract bool UnLockUser(UserInfo user)

Parameters

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

Returns

Type	Description
System.Boolean	True if successful, False if unsuccessful.

UpdateUser(UserInfo)

UpdateUser persists a user to the Data Store.

Declaration

public abstract void UpdateUser(UserInfo user)

Parameters

Type	Name	Description
UserInfo	user	The user to persist to the Data Store.

UpdateUsersOnline(Hashtable)

Updates UserOnline info time window.

Declaration

public abstract void UpdateUsersOnline(Hashtable userList)

Parameters

Type	Name	Description
Hashtable	userList	List of users to update.

UserAgreedToTerms(UserInfo)

User has agreed to terms and conditions for the portal.

Declaration

public abstract void UserAgreedToTerms(UserInfo user)

Parameters

Type	Name	Description
UserInfo	user	The agreeing user.

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

UserLogin attempts to log the user in, and returns the User if successful.

Declaration

public abstract UserInfo UserLogin(int portalId, string username, string password, string verificationCode, ref UserLoginStatus loginStatus)

Parameters

Type	Name	Description
System.Int32	portalId	The Id of the 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.
UserLoginStatus	loginStatus	An enumerated value indicating the login status.

Returns

Type	Description
UserInfo	The User as a UserInfo object.

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

UserLogin attempts to log the user in, and returns the User if successful.

Declaration

public abstract UserInfo UserLogin(int portalId, string username, string password, string authType, string verificationCode, ref UserLoginStatus loginStatus)

Parameters

Type	Name	Description
System.Int32	portalId	The Id of the 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 (may not be used by all Auth types).
System.String	authType	The type of Authentication Used.
System.String	verificationCode	The verification code of the User attempting to log in.
UserLoginStatus	loginStatus	An enumerated value indicating the login status.

Returns

Type	Description
UserInfo	The User as a UserInfo object.

UserRequestsRemoval(UserInfo, Boolean)

Sets a boolean on the user portal to indicate this user has requested that their account be deleted.

Declaration

public abstract void UserRequestsRemoval(UserInfo user, bool remove)

Parameters

Type	Name	Description
UserInfo	user	User requesting removal.
System.Boolean	remove	True if user requests removal, false if the value needs to be reset.

Extension Methods

JsonExtensionsWeb.ToJson(Object)