ClientWindowsAuthenticationMembershipProvider Class

ClientWindowsAuthenticationMembershipProvider Class

 

Enables Windows authentication with client application services.

Namespace:   System.Web.ClientServices.Providers
Assembly:  System.Web.Extensions (in System.Web.Extensions.dll)

System.Object
  System.Configuration.Provider.ProviderBase
    System.Web.Security.MembershipProvider
      System.Web.ClientServices.Providers.ClientWindowsAuthenticationMembershipProvider

public class ClientWindowsAuthenticationMembershipProvider : MembershipProvider

NameDescription
System_CAPS_pubmethodClientWindowsAuthenticationMembershipProvider()

Initializes a new instance of the ClientWindowsAuthenticationMembershipProvider class.

NameDescription
System_CAPS_pubpropertyApplicationName

This property is not used by this class.(Overrides MembershipProvider.ApplicationName.)

System_CAPS_pubpropertyDescription

Gets a brief, friendly description suitable for display in administrative tools or other user interfaces (UIs).(Inherited from ProviderBase.)

System_CAPS_pubpropertyEnablePasswordReset

This property is not used by this class.(Overrides MembershipProvider.EnablePasswordReset.)

System_CAPS_pubpropertyEnablePasswordRetrieval

This property is not used by this class.(Overrides MembershipProvider.EnablePasswordRetrieval.)

System_CAPS_pubpropertyMaxInvalidPasswordAttempts

This property is not used by this class.(Overrides MembershipProvider.MaxInvalidPasswordAttempts.)

System_CAPS_pubpropertyMinRequiredNonAlphanumericCharacters

This property is not used by this class.(Overrides MembershipProvider.MinRequiredNonAlphanumericCharacters.)

System_CAPS_pubpropertyMinRequiredPasswordLength

This property is not used by this class.(Overrides MembershipProvider.MinRequiredPasswordLength.)

System_CAPS_pubpropertyName

Gets the friendly name used to refer to the provider during configuration.(Inherited from ProviderBase.)

System_CAPS_pubpropertyPasswordAttemptWindow

This property is not used by this class.(Overrides MembershipProvider.PasswordAttemptWindow.)

System_CAPS_pubpropertyPasswordFormat

This property is not used by this class.(Overrides MembershipProvider.PasswordFormat.)

System_CAPS_pubpropertyPasswordStrengthRegularExpression

This property is not used by this class.(Overrides MembershipProvider.PasswordStrengthRegularExpression.)

System_CAPS_pubpropertyRequiresQuestionAndAnswer

This property is not used by this class.(Overrides MembershipProvider.RequiresQuestionAndAnswer.)

System_CAPS_pubpropertyRequiresUniqueEmail

This property is not used by this class.(Overrides MembershipProvider.RequiresUniqueEmail.)

NameDescription
System_CAPS_pubmethodChangePassword(String, String, String)

This method is not used by this class.(Overrides MembershipProvider.ChangePassword(String, String, String).)

System_CAPS_pubmethodChangePasswordQuestionAndAnswer(String, String, String, String)
System_CAPS_pubmethodCreateUser(String, String, String, String, String, Boolean, Object, MembershipCreateStatus)
System_CAPS_protmethodDecryptPassword(Byte[])

Decrypts an encrypted password.(Inherited from MembershipProvider.)

System_CAPS_pubmethodDeleteUser(String, Boolean)

This method is not used by this class.(Overrides MembershipProvider.DeleteUser(String, Boolean).)

System_CAPS_protmethodEncryptPassword(Byte[])

Encrypts a password.(Inherited from MembershipProvider.)

System_CAPS_protmethodEncryptPassword(Byte[], MembershipPasswordCompatibilityMode)

Encrypts the specified password using the specified password-compatibility mode.(Inherited from MembershipProvider.)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodFindUsersByEmail(String, Int32, Int32, Int32)

This method is not used by this class.(Overrides MembershipProvider.FindUsersByEmail(String, Int32, Int32, Int32).)

System_CAPS_pubmethodFindUsersByName(String, Int32, Int32, Int32)

This method is not used by this class.(Overrides MembershipProvider.FindUsersByName(String, Int32, Int32, Int32).)

System_CAPS_pubmethodGetAllUsers(Int32, Int32, Int32)

This method is not used by this class.(Overrides MembershipProvider.GetAllUsers(Int32, Int32, Int32).)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetNumberOfUsersOnline()

This method is not used by this class.(Overrides MembershipProvider.GetNumberOfUsersOnline().)

System_CAPS_pubmethodGetPassword(String, String)

This method is not used by this class.(Overrides MembershipProvider.GetPassword(String, String).)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodGetUser(Object, Boolean)

This method is not used by this class.(Overrides MembershipProvider.GetUser(Object, Boolean).)

System_CAPS_pubmethodGetUser(String, Boolean)

This method is not used by this class.(Overrides MembershipProvider.GetUser(String, Boolean).)

System_CAPS_pubmethodGetUserNameByEmail(String)

This method is not used by this class.(Overrides MembershipProvider.GetUserNameByEmail(String).)

System_CAPS_pubmethodInitialize(String, NameValueCollection)

Initializes the provider.(Inherited from ProviderBase.)

System_CAPS_pubmethodLogout()

Logs out the user.

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethodOnValidatingPassword(ValidatePasswordEventArgs)

Raises the ValidatingPassword event if an event handler has been defined.(Inherited from MembershipProvider.)

System_CAPS_pubmethodResetPassword(String, String)

This method is not used by this class.(Overrides MembershipProvider.ResetPassword(String, String).)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_pubmethodUnlockUser(String)

This method is not used by this class.(Overrides MembershipProvider.UnlockUser(String).)

System_CAPS_pubmethodUpdateUser(MembershipUser)

This method is not used by this class.(Overrides MembershipProvider.UpdateUser(MembershipUser).)

System_CAPS_pubmethodValidateUser(String, String)

Automatically authenticates the current user by using the identity supplied by the operating system.(Overrides MembershipProvider.ValidateUser(String, String).)

NameDescription
System_CAPS_pubeventValidatingPassword

Occurs when a user is created, a password is changed, or a password is reset.(Inherited from MembershipProvider.)

You can use client application services to validate users by using Windows authentication. To enable Windows authentication, you configure your application to use the ClientWindowsAuthenticationMembershipProvider class. For more information, see How to: Configure Client Application Services.

After configuration, you can validate users by calling the static Membership.ValidateUser method. The Membership.ValidateUser method internally calls the ValidateUser method.

The ClientWindowsAuthenticationMembershipProvider.ValidateUser method automatically authenticates the current user and sets the static Thread.CurrentPrincipal property to a ClientRolePrincipal object that contains the current WindowsIdentity. If a ClientRoleProvider is configured for your application, you can use the ClientRolePrincipal object to retrieve user role information from the roles service.

You can retrieve a reference to the current ClientWindowsAuthenticationMembershipProvider instance through the static Membership.Provider property. You can use the membership provider reference to call the ClientWindowsAuthenticationMembershipProvider.ValidateUser method directly. Additionally, you will need the membership provider reference to call the Logout method, which is not available in the MembershipProvider base class.

The following example code demonstrates how to use this method to authenticate a user by using Windows authentication. In this example, the value of the static Membership.Provider property is cast to a ClientWindowsAuthenticationMembershipProvider instance. This makes sure that a NullReferenceException will be thrown if you accidentally test this code by using another membership provider.

private bool ValidateUsingWindowsAuthentication()
{
    ClientWindowsAuthenticationMembershipProvider authProvider =
        System.Web.Security.Membership.Provider as
        ClientWindowsAuthenticationMembershipProvider;

    // Call ValidateUser and pass null values for the parameters.
    // This call always returns true.
    return authProvider.ValidateUser(null, null);
}

.NET Framework
Available since 3.5

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

Return to top
Show:
© 2016 Microsoft