Click or drag to resize
AuthenticationHelper Class
Contains method connected with user authentication
Inheritance Hierarchy
SystemObject
  CMS.MembershipAuthenticationHelper

Namespace: CMS.Membership
Assembly: CMS.Membership (in CMS.Membership.dll) Version: 9.0.0
Syntax
C#
public static class AuthenticationHelper

The AuthenticationHelper type exposes the following members.

Fields
  NameDescription
Public fieldStatic memberCloneGlobalUserInfo
Clone global user info.
Public fieldStatic memberDEFAULT_LOGON_PAGE
URL to default logon page.
Public fieldStatic memberGROUP
Constant used for identify group.
Public fieldStatic memberPASSWORD_EXPIRATION_LOCK
Setting value for locking user account to user with expired password
Public fieldStatic memberPASSWORD_EXPIRATION_WARNING
Setting value for displaying warning message to user with expired password
Public fieldStatic memberUSER
Constant used for identify user.
Top
Properties
  NameDescription
Public propertyStatic memberADConnectionStringName
Name of connection string used by AD membership provider.
Public propertyStatic memberADPassword
Password of user used to authenticate against AD by membership provider.
Public propertyStatic memberADUsername
Name of user used to authenticate against AD by membership provider.
Public propertyStatic memberFederationAuthentication
Gets or sets whether federation authentication is used.
Public propertyStatic memberGlobalPublicUser
Global public user object.
Public propertyStatic memberImportExternalRoles
If true, the system imports the external user roles.
Public propertyStatic memberImportExternalUsers
If true, the system imports the external users.
Public propertyStatic memberImportWindowsRoles
Gets or sets whether roles are imported during the Windows/Active directory authentication.
Public propertyStatic memberNetBiosDomainName
Get domain name in NetBios format
Public propertyStatic memberPrincipalContext
Encapsulates the server or domain against which all operations are performed.
Public propertyStatic memberSynchronizeUserGUIDs
Indicates whether to synchronize user's guid during import from Active Directory.
Public propertyStatic memberUseSessionCookies
If true, the session cookies will be used for the authentication.
Top
Methods
  NameDescription
Public methodStatic memberAddUserToKicked
Adds user to kicked.
Public methodStatic memberAuthenticateFacebookConnectUser
Authenticate user with provided Facebook Connect parameters. Create new user if createNew is set to TRUE and user doesn't exist in DB.
Public methodStatic memberAuthenticateLinkedInUser
Authenticates user with LinkedID parameters. It will create new user if not found in DB.
Public methodStatic memberAuthenticateOpenIDUser
Authenticate user with provided OpenID parameters. Create new user if createNew is set to TRUE and user doesn't exist in DB.
Public methodStatic memberAuthenticateUser(String, Boolean, Boolean)
Authenticate given user.
Public methodStatic memberAuthenticateUser(String, String, String, Boolean, AuthenticationSourceEnum)
Authenticates user against the database.
Public methodStatic memberAuthenticateUserAD
Authenticates user against the database.
Public methodStatic memberAuthenticateWindowsLiveUser
Authenticates the Windows Live user with user's LiveID. If user doesn't exists yet and createNew set to true, then it is created.
Public methodStatic memberCanUserLogin
Checks if given user can login to system.
Public methodStatic memberDisplayAccountLockInformation
Indicates if additional info about account lock should be displayed
Public methodStatic memberEnsureExternalUser
Ensures that the external user record is present in the database.
Public methodStatic memberExtendAuthenticationCookieExpiration
Sets the authentication cookie expiration
Public methodStatic memberFinalizeAuthenticationProcess
Finalizes the authentication process. Does all the actions that are needed after successful authentication.
Public methodStatic memberForgottenEmailRequest(String, String, String, String)
Tries to find user based on given user identifier (checks username and email) and if it finds the user email with forgotten password is send. It sends password directly or request for getting/regenerating password based on settings.
Public methodStatic memberForgottenEmailRequest(String, String, String, String, MacroResolver)
Tries to find user based on given user identifier (checks username and email) and if it finds the user email with forgotten password is send. It sends password directly or request for getting/regenerating password based on settings.
Public methodStatic memberForgottenEmailRequest(String, String, String, String, MacroResolver, String, Boolean)
Tries to find user based on given user identifier (checks username and email) and if it finds the user email with forgotten password is send. It sends password directly or request for getting/regenerating password based on settings.
Public methodStatic memberForgottenEmailRequest(String, String, String, String, MacroResolver, String, Boolean, String)
Tries to find user based on given user identifier (checks username and email) and if it finds the user email with forgotten password is send. It sends password directly or request for getting/regenerating password based on settings.
Public methodStatic memberGetCurrentUser
Gets the current user.
Public methodStatic memberGetDomainSamAccountName
Get domain name in NetBiosDomainName\SamAccountName
Public methodStatic memberGetFormsAuthenticationUserName
Checks whether the supplied forms authentication cookie is valid. If the cookie is valid, returns name of the authenticated user. Otherwise returns null. Contains check for BannedIPs Login level.
Public methodStatic memberGetKickedUsers
Returns ID's of kicked users in string in format: ID1,ID2 ...
Public methodStatic memberGetPolicyViolationMessage
Returns a message that the entered password doesn't meet the defined password policy.
Public methodStatic memberGetRegistrationApprovalUrl
Gets URL for user registration approval page (Page where user is required to confirm his registration).
Public methodStatic memberGetResetPasswordUrl
Returns URL of page where user can reset his password.
Public methodStatic memberGetSecuredAreasLogonPage
Returns value of CMSSecuredAreasLogonPage setting key, or returns default logon URL if this setting key is empty.
Public methodStatic memberGetSignOutOnClickScript
Gets the script that performs a SignOut of all the registered third party providers.
Public methodStatic memberGetUnlockAccountUrl
Returns URL of page where user can unlock her account.
Public methodStatic memberGetUserADRoles
Gets the user roles from AD.
Public methodStatic memberGetUserAuthenticationUrl
Prepares the user authentication GUID, adds it as a query string parameter to supplied Url.
Public methodStatic memberGetUserDataFromAuthCookie
Returns an array with userdata from authentication cookie.
Public methodStatic memberGetUserWindowsRoles
Gets the user roles.
Public methodStatic memberHandleAdminEmergencyReset
Handles admin emergency reset
Public methodStatic memberHandleAutomaticSignIn
Check URL query string for authentication parameter and authenticate user.
Public methodStatic memberCheckInvalidPasswordAttempts
Check if logging invalid password attempts is enabled and if so, invalid attempt counter is incremented and if user exceeded maximal number of invalid attempts, her account is locked
Public methodStatic memberCheckPasswordExpiration
Check if user password is expired and optionally according to settings lock expired password account.
Public methodStatic memberImpersonateUser
Impersonates current user.
Public methodStatic memberIsAuthenticated
Returns true if the current user is authenticated.
Public methodStatic memberIsAuthenticationRedirect
Checks whether request is being redirected to a logon page.
Public methodStatic memberIsPasswordExpirationEnabled
Indicates if password expiration is enabled
Public methodStatic memberMaximumInvalidPasswordAttemps
Gets limit of invalid password attempts before user account is locked
Public methodStatic memberNotifyAdministrator
Sends notification e-mail to administrator about user registration.
Public methodStatic memberRegisterCustomSignOutScriptProvider
Registers a custom SignOut script provider.
Public methodStatic memberRemoveExpiredKickedUsers
Removes expired records from KickUsers hashtable.
Public methodStatic memberRemoveSessionID
Removes cookie with session ID which enforces ASP.NET to generate new session ID if RenewSessionAuthChange property is set to true.
Public methodStatic memberRemoveUserFromKicked
Removes user from kicked.
Public methodStatic memberResetPassword
Resets password for user based on his request.
Public methodStatic memberResolveDialogUrl
Resolves the dialog URL. Keeps the URL in case the user is authenticated, uses the secured /cms/dialogs/ prefix to ensure the authentication for already authenticated user.
Public methodStatic memberResolveUIUrl
Resolves the UI URL. Keeps the URL in case the user is authenticated, uses the secured /cms/ prefix to ensure the authentication for already authenticated user.
Public methodStatic memberSendPassword(UserInfo, String, String, String, String, String, MacroResolver)
Sends given user an email with forgotten/new password. (If the new password isn't provided current password is used for the plain text format or new password is generated for the SHA1/SHA2 format.)
Public methodStatic memberSendPassword(UserInfo, String, String, String, String, String, MacroResolver, Boolean)
Sends given user an email with forgotten/new password. (If the new password isn't provided current password is used for the plain text format or new password is generated for the SHA1/SHA2 format.)
Public methodStatic memberSendPasswordRequest(UserInfo, String, String, String, String, MacroResolver, String, Boolean)
Sends e-mail to user for approval request of new password.
Public methodStatic memberSendPasswordRequest(UserInfo, String, String, String, String, MacroResolver, String, Boolean, String)
Sends e-mail to user for approval request of new password.
Public methodStatic memberSendRegistrationEmails
Sends registration emails. Returns string with error if any exception occurred.
Public methodStatic memberSendUnlockAccountRequest
Sends e-mail to user to inform her about her account was locked due to reaching maximum invalid logon attempts.
Public methodStatic memberSetAuthCookieWithUserData
Creates authentication cookie of user with specified custom data.
Public methodStatic memberSetCurrentUser
Sets the current user.
Public methodStatic memberSetWindowsUserCultures
Sets preferred cultures for a windows user
Public methodStatic memberSignOut(String)
Signs the user out.
Public methodStatic memberSignOut(String)
Signs the user out.
Public methodStatic memberUnlockUserAccount
Unlock specified user account
Public methodStatic memberUpdateLastLogonInformation
Updates last logon information of user = last logon time, IP address and agent. Doesn't call SetUserInfo!!
Public methodStatic memberUserKicked
Checks whether the given user is kicked or not.
Public methodStatic memberValidateResetPassword
Validates request of password reset.
Top
See Also