This documentation is archived and is not being maintained.

AuthenticatingEventArgs Class

Provides data for the Authenticating event.


Namespace:  System.Web.ApplicationServices
Assembly:  System.Web.Extensions (in System.Web.Extensions.dll)

public class AuthenticatingEventArgs : EventArgs

The AuthenticatingEventArgs type exposes the following members.

Public propertyAuthenticatedGets or sets a value that indicates whether the user credentials are valid.
Public propertyAuthenticationIsCompleteGets or sets a value that indicates whether the user credentials have been authenticated.
Public propertyCustomCredentialGets additional user values for authentication.
Public propertyPasswordGets the password for the user.
Public propertyUserNameGets the authentication name for the user.

Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

You create a handler for the Authenticating event when you want to customize how the user's credentials are authenticated at run time. The AuthenticatingEventArgs class supplies values to any Authenticating event handler. By using the properties available in this class, you can retrieve the user credentials to customize authentication.

The AuthenticationService class raises the Authenticating event before validating the user credentials. The AuthenticationService class constructs an instance of the AuthenticatingEventArgs object and passes it to any Authenticating event handler.

You can use the UserName, Password and CustomCredential properties to retrieve the user credentials. The CustomCredential property can contain additional values that are required for authentication, such as an identification number.

The Authenticated property indicates whether the user credentials are valid. You set the Authenticated property to the result of your customized authentication. In addition, you set the AuthenticationIsComplete property to true if you have checked the user credentials and do not want the AuthenticationService class to check user credentials through the default membership provider.

The following example shows an event handler that passes the UserName and Password values to a custom membership provider to validate the user credentials. The event handler sets Authenticated to the return value of the ValidateUser method and sets AuthenticationIsComplete to true so that the AuthenticationService class does not validate the credentials.

void AuthenticationService_Authenticating(object sender, System.Web.ApplicationServices.AuthenticatingEventArgs e)
    if (e.UserName.IndexOf("") >= 0)
        e.Authenticated = Membership.Providers["ContosoSqlProvider"].ValidateUser(e.UserName, e.Password);
    else if (e.UserName.IndexOf("") >= 0)
        e.Authenticated = Membership.Providers["FabrikamSqlProvider"].ValidateUser(e.UserName, e.Password);
        e.Authenticated = Membership.Provider.ValidateUser(e.UserName, e.Password);
    e.AuthenticationIsComplete = true;

.NET Framework

Supported in: 4, 3.5

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.