AuthenticablePrincipal.UnlockAccount Method ()

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Unlocks the account if it is currently locked out.

Namespace:   System.DirectoryServices.AccountManagement
Assembly:  System.DirectoryServices.AccountManagement (in System.DirectoryServices.AccountManagement.dll)

public void UnlockAccount()

Exception Condition
PrincipalOperationException

Throws an exception if the caller does not have appropriate rights.

PrincipalOperationException

An exception occurred when saving the changes to the store.

The following example code connects to the LDAP domain "fabrikam.com" with the username (administrator) and password (SecretPwd123) initialized in the PrincipalContext constructor.

A search is performed to find the user with name "John Smith" under the container specified in the PrincipalContext constructor: "CN=Users,DC=fabrikam,DC=com." If the user is found, a check is performed to determine whether this user's account has been locked out. If the account has been locked out, the code example unlocks the account.

PrincipalContext ctx = new PrincipalContext(ContextType.Domain, 
                                         "fabrikam.com", 
                                         "CN=Users,DC=fabrikam,DC=com", 
                                         "administrator", 
                                         "SecretPwd123");

UserPrincipal usr = UserPrincipal.FindByIdentity(ctx, "John Smith");
if (usr != null)
{
    if (usr.IsAccountLockedOut())
        usr.UnlockAccount();

    usr.Dispose();
}
ctx.Dispose(); 

.NET Framework
Available since 3.5

System.DirectoryServices.AccountManagement
AuthenticablePrincipal Class
System.DirectoryServices.AccountManagement Namespace Overview

Return to top
Show: