TestimoX

API Reference

Class

DirectoryOrganizationalUnitHelper

Edit on GitHub
Namespace ADPlayground
Assembly ADPlayground
Source ADPlayground/DirectoryOps/DirectoryOrganizationalUnitHelper.cs:26
Modifiers sealed

Provides standard organizational unit lifecycle operations and content listing.

Inheritance

  • Object
  • DirectoryOrganizationalUnitHelper

Constructors

public DirectoryOrganizationalUnitHelper(Func<String, String, String, DirectoryMutationResult> createOrganizationalUnit = null, Func<String, String, Boolean, DirectoryMutationResult> deleteOrganizationalUnit = null, Func<String, String, String, String, DirectoryMutationResult> moveOrganizationalUnit = null, Func<String, String, Boolean, Int32, String, Nullable<Int32>, Nullable<Int32>, IReadOnlyList<String>, IReadOnlyList<DirectoryOrganizationalUnitListItem>> listOrganizationalUnits = null, Func<String, String, Boolean, Int32, String, IReadOnlyList<String>, IReadOnlyList<DirectoryOrganizationalUnitContentItem>> getOrganizationalUnitContents = null) #
ADPlayground/DirectoryOps/DirectoryOrganizationalUnitHelper.cs:26

Initializes a new instance of the DirectoryOrganizationalUnitHelper class.

Parameters

createOrganizationalUnit System.Func{System.String,System.String,System.String,ADPlayground.DirectoryMutationResult} = null optionalposition: 0
Optional OU creation override.
deleteOrganizationalUnit System.Func{System.String,System.String,System.Boolean,ADPlayground.DirectoryMutationResult} = null optionalposition: 1
Optional OU deletion override.
moveOrganizationalUnit System.Func{System.String,System.String,System.String,System.String,ADPlayground.DirectoryMutationResult} = null optionalposition: 2
Optional OU move override.
listOrganizationalUnits System.Func{System.String,System.String,System.Boolean,System.Int32,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Collections.Generic.IReadOnlyList{System.String},System.Collections.Generic.IReadOnlyList{ADPlayground.DirectoryOrganizationalUnitListItem}} = null optionalposition: 3
Optional OU listing override.
getOrganizationalUnitContents System.Func{System.String,System.String,System.Boolean,System.Int32,System.String,System.Collections.Generic.IReadOnlyList{System.String},System.Collections.Generic.IReadOnlyList{ADPlayground.DirectoryOrganizationalUnitContentItem}} = null optionalposition: 4
Optional OU contents override.

Methods

public DirectoryMutationResult CreateOrganizationalUnit(String name, String parentDistinguishedName, String description = null) #
ADPlayground/DirectoryOps/DirectoryOrganizationalUnitHelper.cs:47
Returns: DirectoryMutationResult

Creates an organizational unit under a parent distinguished name.

Parameters

name System.String requiredposition: 0
Organizational unit name.
parentDistinguishedName System.String requiredposition: 1
Parent DN where the OU should be created.
description System.String = null optionalposition: 2
Optional OU description.

Returns

Mutation result details.

public DirectoryMutationResult DeleteOrganizationalUnit(String identity, String domainName = null, Boolean recursive = false) #
ADPlayground/DirectoryOps/DirectoryOrganizationalUnitHelper.cs:60
Returns: DirectoryMutationResult

Deletes an organizational unit by identity.

Parameters

identity System.String requiredposition: 0
OU identity (DN, ou, or name).
domainName System.String = null optionalposition: 1
Optional domain DNS name.
recursive System.Boolean = false optionalposition: 2
When set, deletes all children recursively.

Returns

Mutation result details.

public IReadOnlyList<DirectoryOrganizationalUnitContentItem> GetOrganizationalUnitContents(String identity, String domainName = null, Boolean recursive = false, Int32 maxResults = 1000, String ldapFilter = null, IEnumerable<String> attributes = null) #
ADPlayground/DirectoryOps/DirectoryOrganizationalUnitHelper.cs:139
Returns: IReadOnlyList<DirectoryOrganizationalUnitContentItem>

Lists contents of an organizational unit.

Parameters

identity System.String requiredposition: 0
OU identity (DN, ou, or name).
domainName System.String = null optionalposition: 1
Optional domain DNS name.
recursive System.Boolean = false optionalposition: 2
When set, includes all descendants.
maxResults System.Int32 = 1000 optionalposition: 3
Maximum number of objects returned.
ldapFilter System.String = null optionalposition: 4
Optional custom LDAP filter; defaults to all objects.
attributes System.Collections.Generic.IEnumerable{System.String} = null optionalposition: 5
Optional additional attributes to include in result attribute bag.

Returns

OU content entries.

public IReadOnlyList<DirectoryOrganizationalUnitListItem> ListOrganizationalUnits(String domainName = null, String searchBaseDistinguishedName = null, Boolean recursive = true, Int32 maxResults = 1000, String nameLike = null, Nullable<Int32> minDepth = null, Nullable<Int32> maxDepth = null, IEnumerable<String> attributes = null) #
ADPlayground/DirectoryOps/DirectoryOrganizationalUnitHelper.cs:103
Returns: IReadOnlyList<DirectoryOrganizationalUnitListItem>

Lists organizational units with hierarchy metadata.

Parameters

domainName System.String = null optionalposition: 0
Optional domain DNS name.
searchBaseDistinguishedName System.String = null optionalposition: 1
Optional search base DN; defaults to domain DN.
recursive System.Boolean = true optionalposition: 2
When set, includes child OUs recursively.
maxResults System.Int32 = 1000 optionalposition: 3
Maximum number of OUs returned.
nameLike System.String = null optionalposition: 4
Optional wildcard filter for OU name/canonical name/DN.
minDepth System.Nullable{System.Int32} = null optionalposition: 5
Optional minimum OU depth (root OU depth is 1).
maxDepth System.Nullable{System.Int32} = null optionalposition: 6
Optional maximum OU depth (root OU depth is 1).
attributes System.Collections.Generic.IEnumerable{System.String} = null optionalposition: 7
Optional additional LDAP attributes to include in result attribute bag.

Returns

OU list entries.

public DirectoryMutationResult MoveOrganizationalUnit(String identity, String targetParentDistinguishedName, String newName = null, String domainName = null) #
ADPlayground/DirectoryOps/DirectoryOrganizationalUnitHelper.cs:77
Returns: DirectoryMutationResult

Moves an organizational unit to a target parent.

Parameters

identity System.String requiredposition: 0
OU identity (DN, ou, or name).
targetParentDistinguishedName System.String requiredposition: 1
Target parent DN.
newName System.String = null optionalposition: 2
Optional new OU name after move.
domainName System.String = null optionalposition: 3
Optional domain DNS name.

Returns

Mutation result details.