UserPrincipal.FindByIdentity Method

Definition

Namespace:

System.DirectoryServices.AccountManagement

Assembly:

System.DirectoryServices.AccountManagement.dll

Package:

System.DirectoryServices.AccountManagement v9.0.0

Returns a user principal object that matches the specified identity value.

Overloads

FindByIdentity(PrincipalContext, IdentityType, String)	Returns a user principal object that matches the specified identity type, and value. This version of the FindByIdentity method determines the format of the identity value.
FindByIdentity(PrincipalContext, String)	Returns a user principal object that matches the specified identity value.

FindByIdentity(PrincipalContext, IdentityType, String)

Source:

User.cs

Returns a user principal object that matches the specified identity type, and value. This version of the FindByIdentity method determines the format of the identity value.

public:
 static System::DirectoryServices::AccountManagement::UserPrincipal ^ FindByIdentity(System::DirectoryServices::AccountManagement::PrincipalContext ^ context, System::DirectoryServices::AccountManagement::IdentityType identityType, System::String ^ identityValue);

public static System.DirectoryServices.AccountManagement.UserPrincipal FindByIdentity (System.DirectoryServices.AccountManagement.PrincipalContext context, System.DirectoryServices.AccountManagement.IdentityType identityType, string identityValue);

static member FindByIdentity : System.DirectoryServices.AccountManagement.PrincipalContext * System.DirectoryServices.AccountManagement.IdentityType * string -> System.DirectoryServices.AccountManagement.UserPrincipal

Public Shared Function FindByIdentity (context As PrincipalContext, identityType As IdentityType, identityValue As String) As UserPrincipal

Parameters

context

PrincipalContext

The PrincipalContext that specifies the server or domain against which operations are performed.

identityType

IdentityType

A IdentityType enumeration value that specifies the format of the identityValue parameter.

identityValue

String

The identity of the user principal. This parameter can be any format that is contained in the IdentityType enumeration.

Returns

UserPrincipal

A UserPrincipal object that matches the specified identity value and type, or null if no matches are found.

Exceptions

MultipleMatchesException

Multiple user principal objects matching the current user object were found.

InvalidEnumArgumentException

The identity value is not a valid IdentityType enumeration value.

Examples

The following code connects to the local computer store. Since the credentials are not specified in the PrincipalContext constructor, the credentials of the user running the current thread are used.

A search is performed to find the user who has SamAccountName "Guest".

If the user is found, a check is performed to determine whether this user's account is enabled. If the account is not enabled, the example code enables it.

PrincipalContext ctx = new PrincipalContext(ContextType.Machine);  

UserPrincipal usr = UserPrincipal.FindByIdentity(ctx,   
                                           IdentityType.SamAccountName,   
                                           "Guest");  

if(usr != null)  
{  
    if (usr.Enabled == false)  
        usr.Enabled = true;  

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

FindByIdentity(PrincipalContext, String)

Source:

User.cs

Returns a user principal object that matches the specified identity value.

public:
 static System::DirectoryServices::AccountManagement::UserPrincipal ^ FindByIdentity(System::DirectoryServices::AccountManagement::PrincipalContext ^ context, System::String ^ identityValue);

public static System.DirectoryServices.AccountManagement.UserPrincipal FindByIdentity (System.DirectoryServices.AccountManagement.PrincipalContext context, string identityValue);

static member FindByIdentity : System.DirectoryServices.AccountManagement.PrincipalContext * string -> System.DirectoryServices.AccountManagement.UserPrincipal

Public Shared Function FindByIdentity (context As PrincipalContext, identityValue As String) As UserPrincipal

Parameters

context

PrincipalContext

The PrincipalContext that specifies the server or domain against which operations are performed.

identityValue

String

The identity of the user principal. This parameter can be any format that is contained in the IdentityType enumeration.

Returns

UserPrincipal

A UserPrincipal object that matches the specified identity value, or null if no matches are found.

Exceptions

MultipleMatchesException

Multiple user principal objects matching the current user object were found.