AddUserRole

Signature

public static void AddUserRole(int portalId, int userId, int roleId)

Example

AddUserRole(portalId, userId, roleId)

Signature

public static void AddUserRole(int portalId, int userId, int roleId, bool notifyUser)

Example

AddUserRole(portalId, userId, roleId, notifyUser)

AuthoriseUser

Signature

public static void AuthoriseUser(int portalId, int userId)

Example

AuthoriseUser(portalId, userId)

ChangePassword

Signature

public static bool ChangePassword(int portalId, int userId, string newPassword)

Example

ChangePassword(portalId, userId, newPassword)

ChangePasswordAction

Description: 0 = OK 1 = password length fail 2 = Validate minimum non-alphanumeric characters fail 3 = Validate password strength regex fail 4 = general fail

Signature

public static int ChangePasswordAction(int portalId, int userId, string newPassword)

Example

ChangePasswordAction(portalId, userId, newPassword)

CreateUser

Signature

public static string CreateUser(int portalId, string username, string email, string roleName = "")

Example

CreateUser(portalId, username, email, roleName)

DeleteUser

Description: Move user to recycle bin.

Signature

public static void DeleteUser(int portalId, int userId, bool notify = false, bool deleteAdmin = false)

Example

DeleteUser(portalId, userId, notify, deleteAdmin)

DoLogin

Description: Do login using gereric login form data. xpath must use... var username = postInfo.GetXmlProperty("genxml/text/username"); var password = postInfo.GetXmlProperty("genxml/hidden/password"); var rememberme = postInfo.GetXmlPropertyBool("genxml/checkbox/rememberme");

Signature

public static bool DoLogin(SessionParams sessionParams, string username, string password, bool rememberme)

Example

DoLogin(sessionParams, username, password, rememberme)

Signature

public static bool DoLogin(SimplisityInfo postInfo, SimplisityInfo paramInfo)

Example

DoLogin(postInfo, paramInfo)

GetCurrentUserDisplayName

Signature

public static string GetCurrentUserDisplayName()

Example

GetCurrentUserDisplayName()

GetCurrentUserEmail

Signature

public static string GetCurrentUserEmail()

Example

GetCurrentUserEmail()

GetCurrentUserId

Signature

public static int GetCurrentUserId()

Example

GetCurrentUserId()

GetCurrentUserName

Signature

public static string GetCurrentUserName()

Example

GetCurrentUserName()

GetRoleById

Signature

public static SimplisityRecord GetRoleById(int portalId, int roleId)

Example

GetRoleById(portalId, roleId)

GetRoleByName

Signature

public static SimplisityRecord GetRoleByName(int portalId, string roleName)

Example

GetRoleByName(portalId, roleName)

GetRoles

Signature

public static Dictionary<int, string> GetRoles(int portalId)

Example

GetRoles(portalId)

GetSuperUsers

Signature

public static List<SimplisityRecord> GetSuperUsers()

Example

GetSuperUsers()

GetUserData

Signature

public static UserData GetUserData(int portalId, int userId)

Example

GetUserData(portalId, userId)

GetUserDataByEmail

Signature

public static UserData GetUserDataByEmail(int portalId, string email)

Example

GetUserDataByEmail(portalId, email)

GetUserDataByUsername

Signature

public static UserData GetUserDataByUsername(int portalId, string username)

Example

GetUserDataByUsername(portalId, username)

GetUserIdByEmail

Signature

public static int GetUserIdByEmail(int portalId, string email)

Example

GetUserIdByEmail(portalId, email)

GetUserIdByUserName

Signature

public static int GetUserIdByUserName(int portalId, string username)

Example

GetUserIdByUserName(portalId, username)

GetUserProfileListField

Description: Returns the key/value pairs of a DNN profile list field (e.g. a dropdown such as "Location"). The list entries are looked up from the DNN Lists table using the profile property's list name.

Signature

public static Dictionary<string, string> GetUserProfileListField(int portalId, string fieldName)

Example

GetUserProfileListField(portalId, fieldName)

GetUserProfileProperties

Signature

public static Dictionary<string, string> GetUserProfileProperties(int portalId, int userId)

Example

GetUserProfileProperties(portalId, userId)

Signature

public static Dictionary<string, string> GetUserProfileProperties(string userId)

Example

GetUserProfileProperties(userId)

GetUserRoles

Signature

public static List<string> GetUserRoles(int portalid = -1, int userId = -1)

Example

GetUserRoles(portalid, userId)

GetUsers

Description: Return list of users in XML SimplisityRecord. XML Format "user/email user/username user/userid user/displayname"

Signature

public static List<SimplisityRecord> GetUsers(int portalId, string inRole = "")

Example

GetUsers(portalId, inRole)

Signature

public static List<SimplisityRecord> GetUsers(int portalId, int pageNumber, int pageSize, ref int totalRecord, bool includeDeleted = false, bool superUsersOnly = false)

Example

GetUsers(portalId, pageNumber, pageSize, totalRecord, includeDeleted, superUsersOnly)

Signature

public static List<SimplisityRecord> GetUsers(int portalId, string searchtext, int returnLimit = 100)

Example

GetUsers(portalId, searchtext, returnLimit)

GetUsersUserData

Signature

public static List<UserData> GetUsersUserData(int portalId, string searchtext, int returnLimit = 100)

Example

GetUsersUserData(portalId, searchtext, returnLimit)

GetValidUser

Signature

public static UserInfo GetValidUser(int PortalId, string username, string password)

Example

GetValidUser(PortalId, username, password)

HasModuleAccess

Description: Check if a user has access to a specific module

Signature

public static bool HasModuleAccess(int portalId, int userId, int moduleId, string permissionKey = "VIEW")

Example

HasModuleAccess(portalId, userId, moduleId, permissionKey)

IsAdministrator

Signature

public static Boolean IsAdministrator()

Example

IsAdministrator()

Signature

public static bool IsAdministrator(int portalId, int userId)

Example

IsAdministrator(portalId, userId)

IsAuthorised

Signature

public static bool IsAuthorised()

Example

IsAuthorised()

Signature

public static bool IsAuthorised(int portalId, int userId)

Example

IsAuthorised(portalId, userId)

IsClientOnly

Signature

public static Boolean IsClientOnly()

Example

IsClientOnly()

IsEditor

Signature

public static Boolean IsEditor()

Example

IsEditor()

IsInRole

Signature

public static bool IsInRole(int portalId, int userId, string role)

Example

IsInRole(portalId, userId, role)

Signature

public static bool IsInRole(string role)

Example

IsInRole(role)

IsManager

Signature

public static Boolean IsManager()

Example

IsManager()

IsSuperUser

Signature

public static bool IsSuperUser(int portalId, int userId)

Example

IsSuperUser(portalId, userId)

Signature

public static bool IsSuperUser()

Example

IsSuperUser()

IsValidUser

Signature

public static bool IsValidUser(int PortalId, string username)

Example

IsValidUser(PortalId, username)

Signature

public static bool IsValidUser(int PortalId, string username, string password)

Example

IsValidUser(PortalId, username, password)

Signature

public static bool IsValidUser(int portalId, int userId)

Example

IsValidUser(portalId, userId)

LoginForm

Signature

public static string LoginForm(string systemkey, SimplisityInfo sInfo, string interfacekey, int userid)

Example

LoginForm(systemkey, sInfo, interfacekey, userid)

RegisterForm

Signature

public static string RegisterForm(SimplisityInfo systemInfo, SimplisityInfo sInfo, string interfacekey, int userid)

Example

RegisterForm(systemInfo, sInfo, interfacekey, userid)

RegisterUser

Signature

public static string RegisterUser(SimplisityInfo sInfo, string currentCulture = "")

Example

RegisterUser(sInfo, currentCulture)

Signature

public static string RegisterUser(string displayname, string username, string useremail, string password, string confirmpassword, string currentCulture, bool approved)

Example

RegisterUser(displayname, username, useremail, password, confirmpassword, currentCulture, approved)

RemoveUser

Description: Remove user from recyclebin (hard delete)

Signature

public static void RemoveUser(int portalId, int userId, bool notify = false, bool deleteAdmin = false)

Example

RemoveUser(portalId, userId, notify, deleteAdmin)

RemoveUserRole

Signature

public static void RemoveUserRole(int portalId, int userId, int roleId)

Example

RemoveUserRole(portalId, userId, roleId)

ResetPass

Signature

public static bool ResetPass(string emailaddress, bool sendEmail)

Example

ResetPass(emailaddress, sendEmail)

SetCurrentUserDisplayName

Signature

public static void SetCurrentUserDisplayName(string displayName)

Example

SetCurrentUserDisplayName(displayName)

SetRemovalRequest

Signature

public static void SetRemovalRequest(int portalId, int userId, bool remove = true)

Example

SetRemovalRequest(portalId, userId, remove)

SetUserProfileProperties

Signature

public static void SetUserProfileProperties(String userId, Dictionary<string, string> properties)

Example

SetUserProfileProperties(userId, properties)

Signature

public static void SetUserProfileProperties(int portalId, int userId, Dictionary<string, string> properties)

Example

SetUserProfileProperties(portalId, userId, properties)

SignOut

Signature

public static void SignOut()

Example

SignOut()

UnAuthoriseUser

Signature

public static void UnAuthoriseUser(int portalId, int userId)

Example

UnAuthoriseUser(portalId, userId)

UnDeleteUser

Signature

public static void UnDeleteUser(int portalId, int userId)

Example

UnDeleteUser(portalId, userId)

UnlockUser

Description: Unlocks a user account that has been locked out by DNN's membership provider (e.g. after too many failed login attempts). Also clears any pending "update password" requirement so the user can log in normally again.

Signature

public static bool UnlockUser(int portalId, int userId)

Example

UnlockUser(portalId, userId)

Signature

public static bool UnlockUser(int portalId, string usernameOrEmail)

Example

UnlockUser(portalId, usernameOrEmail)

UpdateEmail

Description: Updates the user's email address and, if the portal is configured to use email as username, also updates the username to match the new email.

Signature

public static UserData UpdateEmail(int portalId, int userId, string newEmail)

Example

UpdateEmail(portalId, userId, newEmail)

UpdateOrCreateUserProfileProperty

Description: Updates or creates a DNN user profile property for a user in the specified portal. If the property definition doesn't exist in the portal, it will be created.

Signature

public static bool UpdateOrCreateUserProfileProperty(int userId, string key, string value, int portalId = 0, string category = "Custom", bool visibilityAllUsers = false)

Example

UpdateOrCreateUserProfileProperty(userId, key, value, portalId, category, visibilityAllUsers)

UserLogin

Description: Validates and logs in a user, using an explicit portalId rather than ambient PortalSettings.Current. This ensures the correct portal-level lockout/security settings (MaxInvalidPasswordAttempts, etc.) are enforced, which is critical in AJAX/API request pipelines where PortalSettings.Current may not be reliably populated.

Signature

public static bool UserLogin(int portalId, string userHostAddress, string username, string password, bool rememberme)

Example

UserLogin(portalId, userHostAddress, username, password, rememberme)

UserLoginNoPassword

Description: Logs a user in WITHOUT password verification. Used for trust-based flows (e.g. SSO token consumption, auto-login) where identity has already been established by another mechanism (signed token, etc).

Signature

public static void UserLoginNoPassword(int portalId, string portalName, string userHostAddress, string username, bool rememberme)

Example

UserLoginNoPassword(portalId, portalName, userHostAddress, username, rememberme)