AuthenticationHelper Class

Contains method connected with user authentication

Inheritance Hierarchy

System.Object
  CMS.Membership.AuthenticationHelper

Namespace: CMS.Membership
Assembly: CMS.Membership (in CMS.Membership.dll) Version: 8.2.23

Syntax

public static class AuthenticationHelper

The AuthenticationHelper type exposes the following members.

Methods

	Name	Description
Public method Static member	AddUserToKicked	Adds user to kicked.
Public method Static member	AuthenticateFacebookConnectUser	Authenticate user with provided Facebook Connect parameters. Create new user if createNew is set to TRUE and user doesn't exist in DB.
Public method Static member	AuthenticateLinkedInUser	Authenticates user with LinkedID parameters. It will create new user if not found in DB.
Public method Static member	AuthenticateOpenIDUser	Authenticate user with provided OpenID parameters. Create new user if createNew is set to TRUE and user doesn't exist in DB.
Public method Static member	AuthenticateUser(String, Boolean, Boolean)	Authenticate given user.
Public method Static member	AuthenticateUser(String, String, String, Boolean, AuthenticationSourceEnum)	Authenticates user against the database.
Public method Static member	AuthenticateUserAD	Authenticates user against the database.
Public method Static member	AuthenticateWindowsLiveUser	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 method Static member	CanUserLogin	Checks if given user can login to system.
Public method Static member	DisplayAccountLockInformation	Indicates if additional info about account lock should be displayed
Public method Static member	EnsureExternalUser	Ensures that the external user record is present in the database.
Public method Static member	ExtendAuthenticationCookieExpiration	Sets the authentication cookie expiration
Public method Static member	FinalizeAuthenticationProcess	Finalizes the authentication process. Does all the actions that are needed after successful authentication.
Public method Static member	ForgottenEmailRequest(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 method Static member	ForgottenEmailRequest(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 method Static member	ForgottenEmailRequest(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 method Static member	ForgottenEmailRequest(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 method Static member	GetCurrentUser	Gets the current user.
Public method Static member	GetDomainSamAccountName	Get domain name in NetBiosDomainName\SamAccountName
Public method Static member	GetFormsAuthenticationUserName	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 method Static member	GetKickedUsers	Returns ID's of kicked users in string in format: ID1,ID2 ...
Public method Static member	GetPolicyViolationMessage	Returns a message that the entered password doesn't meet the defined password policy.
Public method Static member	GetRegistrationApprovalUrl(String, Guid, String, Boolean)	Gets URL for user registration approval page (Page where user is required to confirm his registration).
Public method Static member	GetRegistrationApprovalUrl(String, Guid, String, Int32)	Obsolete. Get URL for user registration approval page. Returns string with URL.
Public method Static member	GetRegistrationApprovalUrl(String, Guid, String, Boolean, Int32)	Obsolete. Gets URL for user registration approval page (Page where user is required to confirm his registration).
Public method Static member	GetResetPasswordUrl	Returns URL of page where user can reset his password.
Public method Static member	GetSignOutOnClickScript	Gets the script that performs a SignOut of all the registered third party providers.
Public method Static member	GetUnlockAccountUrl	Returns URL of page where user can unlock her account.
Public method Static member	GetUserADRoles	Gets the user roles from AD.
Public method Static member	GetUserAuthenticationUrl	Prepares the user authentication GUID, adds it as a query string parameter to supplied Url.
Public method Static member	GetUserDataFromAuthCookie	Returns an array with userdata from authentication cookie.
Public method Static member	GetUserWindowsRoles	Gets the user roles.
Public method Static member	HandleAdminEmergencyReset	Handles admin emergency reset
Public method Static member	HandleAutomaticSignIn	Check URL query string for authentication parameter and authenticate user.
Public method Static member	CheckInvalidPasswordAttempts	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 method Static member	CheckPasswordExpiration	Check if user password is expired and optionally according to settings lock expired password account.
Public method Static member	ImpersonateUser	Impersonates current user.
Public method Static member	IsAuthenticated	Returns true if the current user is authenticated.
Public method Static member	IsAuthenticationRedirect	Checks whether request is being redirected to a logon page.
Public method Static member	IsPasswordExpirationEnabled	Indicates if password expiration is enabled
Public method Static member	LogoutUser	Obsolete. Signs out user and removes their shopping cart.
Public method Static member	MaximumInvalidPasswordAttemps	Gets limit of invalid password attempts before user account is locked
Public method Static member	NotifyAdministrator	Sends notification e-mail to administrator about user registration.
Public method Static member	RegisterCustomSignOutScriptProvider	Registers a custom SignOut script provider.
Public method Static member	RemoveExpiredKickedUsers	Removes expired records from KickUsers hashtable.
Public method Static member	RemoveSessionID	Removes cookie with session ID which enforces ASP.NET to generate new session ID if RenewSessionAuthChange property is set to true.
Public method Static member	RemoveUserFromKicked	Removes user from kicked.
Public method Static member	ResetPassword	Resets password for user based on his request.
Public method Static member	ResolveDialogUrl	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 method Static member	ResolveMacrosWithParameters	Resolves the macros within given text.
Public method Static member	ResolveUIUrl	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 method Static member	SendPassword(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 method Static member	SendPassword(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 method Static member	SendPasswordRequest(UserInfo, String, String, String, String, MacroResolver, String, Boolean)	Sends e-mail to user for approval request of new password.
Public method Static member	SendPasswordRequest(UserInfo, String, String, String, String, MacroResolver, String, Boolean, String)	Sends e-mail to user for approval request of new password.
Public method Static member	SendRegistrationEmails	Sends registration emails. Returns string with error if any exception occurred.
Public method Static member	SendUnlockAccountRequest	Sends e-mail to user to inform her about her account was locked due to reaching maximum invalid logon attempts.
Public method Static member	SetAuthCookieWithUserData	Creates authentication cookie of user with specified custom data.
Public method Static member	SetCurrentUser	Sets the current user.
Public method Static member	SetWindowsUserCultures	Sets preferred cultures for a windows user
Public method Static member	SignOut(String)	Signs the user out.
Public method Static member	SignOut(String)	Signs the user out.
Public method Static member	UnlockUserAccount	Unlock specified user account
Public method Static member	UpdateLastLogonInformation	Updates last logon information of user = last logon time, IP address and agent. Doesn't call SetUserInfo!!
Public method Static member	UserKicked	Checks whether the given user is kicked or not.
Public method Static member	ValidateResetPassword	Validates request of password reset.

Fields

	Name	Description
Public field Static member	CloneGlobalUserInfo	Clone global user info.
Public field Static member	GROUP	Constant used for identify group.
Public field Static member	PASSWORD_EXPIRATION_LOCK	Setting value for locking user account to user with expired password
Public field Static member	PASSWORD_EXPIRATION_WARNING	Setting value for displaying warning message to user with expired password
Public field Static member	USER	Constant used for identify user.

Properties

	Name	Description
Public property Static member	ADConnectionStringName	Name of connection string used by AD membership provider.
Public property Static member	ADPassword	Password of user used to authenticate against AD by membership provider.
Public property Static member	ADUsername	Name of user used to authenticate against AD by membership provider.
Public property Static member	FederationAuthentication	Gets or sets whether federation authentication is used.
Public property Static member	GlobalPublicUser	Global public user object.
Public property Static member	ImportExternalRoles	If true, the system imports the external user roles.
Public property Static member	ImportExternalUsers	If true, the system imports the external users.
Public property Static member	ImportWindowsRoles	Gets or sets whether roles are imported during the Windows/Active directory authentication.
Public property Static member	NetBiosDomainName	Get domain name in NetBios format
Public property Static member	PrincipalContext	Encapsulates the server or domain against which all operations are performed.
Public property Static member	SynchronizeUserGUIDs	Indicates whether to synchronize user's guid during import from Active Directory.
Public property Static member	UseSessionCookies	If true, the session cookies will be used for the authentication.