C# Class ADLib.ActiveDirectory

This class encapsulates an Active Directory connection, and handles common tasks
Mostra file Open project: bolenc/Active-Directory-Examples Class Usage Examples

Public Methods

Method Description
ActiveDirectory ( string container, string name, string userid, string password ) : System

Create an Active Directory connection

AddUserToGroup ( System.DirectoryServices.AccountManagement.UserPrincipal adUser, string groupName ) : void

Adds the user to the specified group

ConnectionStringFor ( string item = "" ) : string
CreateGroup ( string groupName, System.Boolean isUserGroup = true ) : System.DirectoryServices.AccountManagement.GroupPrincipal

Creates a new group

Find ( ADCriteria criteria = null, ADObjectType objectType = ADObjectType.User ) : IEnumerable
Find ( string query, ADObjectType objectType = ADObjectType.User ) : IEnumerable

Performs a search on the current connection using the given query string (NOTE: Only users currently work)

GetGroup ( string groupName, System.DirectoryServices.AccountManagement.PrincipalContext context = null ) : System.DirectoryServices.AccountManagement.GroupPrincipal

Get the group with the specified id or null if not found

GetGroupByGuid ( System.Guid guid, System.DirectoryServices.AccountManagement.PrincipalContext context = null ) : System.DirectoryServices.AccountManagement.GroupPrincipal

Get the group with the specified guid or null if not found

GetOrCreate ( string groupName, System.Boolean isUserGroup = true ) : System.DirectoryServices.AccountManagement.GroupPrincipal
GetPrincipal ( System.DirectoryServices.SearchResult item ) : Principal
GetUser ( string userID, System.DirectoryServices.AccountManagement.PrincipalContext context = null ) : System.DirectoryServices.AccountManagement.UserPrincipal

Returns the user with the specified ID or null if not found

GetUserByGuid ( System.Guid guid, System.DirectoryServices.AccountManagement.PrincipalContext context = null ) : System.DirectoryServices.AccountManagement.UserPrincipal

Returns the user with the specified ID or null if not found

GetUserBySid ( object Sid ) : System.DirectoryServices.AccountManagement.UserPrincipal
IsInGroup ( System.DirectoryServices.AccountManagement.UserPrincipal adUser, string groupName ) : bool

Returns true if the user is in the specified group

RemoveUserFromGroup ( System.DirectoryServices.AccountManagement.UserPrincipal adUser, string groupName ) : void

Removes the user from the specified group

Private Methods

Method Description
GetGlobalContainer ( string container ) : string
SysMessage ( string message ) : void

Writes debug statements to the output window

Method Details

ActiveDirectory() public method

Create an Active Directory connection
public ActiveDirectory ( string container, string name, string userid, string password ) : System
container string
name string
userid string
password string
return System

AddUserToGroup() public method

Adds the user to the specified group
public AddUserToGroup ( System.DirectoryServices.AccountManagement.UserPrincipal adUser, string groupName ) : void
adUser System.DirectoryServices.AccountManagement.UserPrincipal User to add
groupName string Group to which the user should be added
return void

ConnectionStringFor() public method

public ConnectionStringFor ( string item = "" ) : string
item string
return string

CreateGroup() public method

Creates a new group
public CreateGroup ( string groupName, System.Boolean isUserGroup = true ) : System.DirectoryServices.AccountManagement.GroupPrincipal
groupName string The name of the new group
isUserGroup System.Boolean If true (default), the new group will be made a subgroup of Domain Users
return System.DirectoryServices.AccountManagement.GroupPrincipal

Find() public method

public Find ( ADCriteria criteria = null, ADObjectType objectType = ADObjectType.User ) : IEnumerable
criteria ADCriteria
objectType ADObjectType
return IEnumerable

Find() public method

Performs a search on the current connection using the given query string (NOTE: Only users currently work)
public Find ( string query, ADObjectType objectType = ADObjectType.User ) : IEnumerable
query string The query string
objectType ADObjectType What objects to search for (defaults to User)
return IEnumerable

GetGroup() public method

Get the group with the specified id or null if not found
public GetGroup ( string groupName, System.DirectoryServices.AccountManagement.PrincipalContext context = null ) : System.DirectoryServices.AccountManagement.GroupPrincipal
groupName string ID of the group
context System.DirectoryServices.AccountManagement.PrincipalContext
return System.DirectoryServices.AccountManagement.GroupPrincipal

GetGroupByGuid() public method

Get the group with the specified guid or null if not found
public GetGroupByGuid ( System.Guid guid, System.DirectoryServices.AccountManagement.PrincipalContext context = null ) : System.DirectoryServices.AccountManagement.GroupPrincipal
guid System.Guid
context System.DirectoryServices.AccountManagement.PrincipalContext
return System.DirectoryServices.AccountManagement.GroupPrincipal

GetOrCreate() public method

public GetOrCreate ( string groupName, System.Boolean isUserGroup = true ) : System.DirectoryServices.AccountManagement.GroupPrincipal
groupName string
isUserGroup System.Boolean
return System.DirectoryServices.AccountManagement.GroupPrincipal

GetPrincipal() public method

public GetPrincipal ( System.DirectoryServices.SearchResult item ) : Principal
item System.DirectoryServices.SearchResult
return Principal

GetUser() public method

Returns the user with the specified ID or null if not found
public GetUser ( string userID, System.DirectoryServices.AccountManagement.PrincipalContext context = null ) : System.DirectoryServices.AccountManagement.UserPrincipal
userID string ID of the user
context System.DirectoryServices.AccountManagement.PrincipalContext
return System.DirectoryServices.AccountManagement.UserPrincipal

GetUserByGuid() public method

Returns the user with the specified ID or null if not found
public GetUserByGuid ( System.Guid guid, System.DirectoryServices.AccountManagement.PrincipalContext context = null ) : System.DirectoryServices.AccountManagement.UserPrincipal
guid System.Guid
context System.DirectoryServices.AccountManagement.PrincipalContext
return System.DirectoryServices.AccountManagement.UserPrincipal

GetUserBySid() public method

public GetUserBySid ( object Sid ) : System.DirectoryServices.AccountManagement.UserPrincipal
Sid object
return System.DirectoryServices.AccountManagement.UserPrincipal

IsInGroup() public method

Returns true if the user is in the specified group
public IsInGroup ( System.DirectoryServices.AccountManagement.UserPrincipal adUser, string groupName ) : bool
adUser System.DirectoryServices.AccountManagement.UserPrincipal The user
groupName string The ID of the group to check for membership
return bool

RemoveUserFromGroup() public method

Removes the user from the specified group
public RemoveUserFromGroup ( System.DirectoryServices.AccountManagement.UserPrincipal adUser, string groupName ) : void
adUser System.DirectoryServices.AccountManagement.UserPrincipal User to remove
groupName string Group from which the user should be removed
return void