TestimoX

API Reference

Class

DirectoryAccountHelper

Edit on GitHub
Namespace ADPlayground
Assembly ADPlayground
Source ADPlayground/DirectoryOps/DirectoryAccountHelper.cs:38
Modifiers sealed

Provides stable, direct directory write operations for account and group lifecycle workflows.

Inheritance

  • Object
  • DirectoryAccountHelper

Constructors

public DirectoryAccountHelper(Func<String, String, DirectoryMutationResult> deleteUser = null, Func<String, String, DirectoryMutationResult> enableUser = null, Func<String, String, DirectoryMutationResult> disableUser = null, Func<String, String, DirectoryMutationResult> deleteComputer = null, Func<String, String, DirectoryMutationResult> enableComputer = null, Func<String, String, DirectoryMutationResult> disableComputer = null, Func<String, String, String, Boolean, DirectoryMutationResult> resetUserPassword = null, Func<String, String, String, DirectoryMutationResult> resetComputerPassword = null, Func<String, String, DirectoryMutationResult> deleteGroup = null, Func<String, String, String, DirectoryMutationResult> addGroupMember = null, Func<String, String, String, DirectoryMutationResult> removeGroupMember = null) #
ADPlayground/DirectoryOps/DirectoryAccountHelper.cs:38

Initializes a new instance of the DirectoryAccountHelper class.

Parameters

deleteUser System.Func{System.String,System.String,ADPlayground.DirectoryMutationResult} = null optionalposition: 0
Optional override for user deletion.
enableUser System.Func{System.String,System.String,ADPlayground.DirectoryMutationResult} = null optionalposition: 1
Optional override for user enable.
disableUser System.Func{System.String,System.String,ADPlayground.DirectoryMutationResult} = null optionalposition: 2
Optional override for user disable.
deleteComputer System.Func{System.String,System.String,ADPlayground.DirectoryMutationResult} = null optionalposition: 3
Optional override for computer deletion.
enableComputer System.Func{System.String,System.String,ADPlayground.DirectoryMutationResult} = null optionalposition: 4
Optional override for computer enable.
disableComputer System.Func{System.String,System.String,ADPlayground.DirectoryMutationResult} = null optionalposition: 5
Optional override for computer disable.
resetUserPassword System.Func{System.String,System.String,System.String,System.Boolean,ADPlayground.DirectoryMutationResult} = null optionalposition: 6
Optional override for user password reset.
resetComputerPassword System.Func{System.String,System.String,System.String,ADPlayground.DirectoryMutationResult} = null optionalposition: 7
Optional override for computer password reset.
deleteGroup System.Func{System.String,System.String,ADPlayground.DirectoryMutationResult} = null optionalposition: 8
Optional override for group deletion.
addGroupMember System.Func{System.String,System.String,System.String,ADPlayground.DirectoryMutationResult} = null optionalposition: 9
Optional override for adding group membership.
removeGroupMember System.Func{System.String,System.String,System.String,ADPlayground.DirectoryMutationResult} = null optionalposition: 10
Optional override for removing group membership.

Methods

public DirectoryMutationResult AddGroupMember(String groupIdentity, String memberIdentity, String domainName = null) #
ADPlayground/DirectoryOps/DirectoryAccountHelper.cs:179
Returns: DirectoryMutationResult

Adds a member to a group.

Parameters

groupIdentity System.String requiredposition: 0
The group identity (sAMAccountName, DN, mail, or name).
memberIdentity System.String requiredposition: 1
Member identity (sAMAccountName, UPN, dNSHostName, DN, mail, or name).
domainName System.String = null optionalposition: 2
Optional domain DNS name. When omitted, domain is inferred from group identity hints before falling back to current machine context.

Returns

Mutation result describing the action.

public DirectoryMutationResult DeleteComputer(String identity, String domainName = null) #
ADPlayground/DirectoryOps/DirectoryAccountHelper.cs:103
Returns: DirectoryMutationResult

Deletes a computer account by identity.

Parameters

identity System.String requiredposition: 0
The computer identity (sAMAccountName, dNSHostName, DN, or name).
domainName System.String = null optionalposition: 1
Optional domain DNS name. When omitted, domain is inferred from identity hints before falling back to current machine context.

Returns

Mutation result describing the action.

public DirectoryMutationResult DeleteGroup(String identity, String domainName = null) #
ADPlayground/DirectoryOps/DirectoryAccountHelper.cs:167
Returns: DirectoryMutationResult

Deletes a group by identity.

Parameters

identity System.String requiredposition: 0
The group identity (sAMAccountName, DN, mail, or name).
domainName System.String = null optionalposition: 1
Optional domain DNS name. When omitted, domain is inferred from identity hints before falling back to current machine context.

Returns

Mutation result describing the action.

public DirectoryMutationResult DeleteUser(String identity, String domainName = null) #
ADPlayground/DirectoryOps/DirectoryAccountHelper.cs:70
Returns: DirectoryMutationResult

Deletes a user account by identity.

Parameters

identity System.String requiredposition: 0
The user identity (sAMAccountName, UPN, DN, mail, or name).
domainName System.String = null optionalposition: 1
Optional domain DNS name. When omitted, domain is inferred from identity hints before falling back to current machine context.

Returns

Mutation result describing the action.

public DirectoryMutationResult DisableComputer(String identity, String domainName = null) #
ADPlayground/DirectoryOps/DirectoryAccountHelper.cs:125
Returns: DirectoryMutationResult

Disables a computer account by identity.

Parameters

identity System.String requiredposition: 0
The computer identity (sAMAccountName, dNSHostName, DN, or name).
domainName System.String = null optionalposition: 1
Optional domain DNS name. When omitted, domain is inferred from identity hints before falling back to current machine context.

Returns

Mutation result describing the action.

public DirectoryMutationResult DisableUser(String identity, String domainName = null) #
ADPlayground/DirectoryOps/DirectoryAccountHelper.cs:92
Returns: DirectoryMutationResult

Disables a user account by identity.

Parameters

identity System.String requiredposition: 0
The user identity (sAMAccountName, UPN, DN, mail, or name).
domainName System.String = null optionalposition: 1
Optional domain DNS name. When omitted, domain is inferred from identity hints before falling back to current machine context.

Returns

Mutation result describing the action.

public DirectoryMutationResult EnableComputer(String identity, String domainName = null) #
ADPlayground/DirectoryOps/DirectoryAccountHelper.cs:114
Returns: DirectoryMutationResult

Enables a computer account by identity.

Parameters

identity System.String requiredposition: 0
The computer identity (sAMAccountName, dNSHostName, DN, or name).
domainName System.String = null optionalposition: 1
Optional domain DNS name. When omitted, domain is inferred from identity hints before falling back to current machine context.

Returns

Mutation result describing the action.

public DirectoryMutationResult EnableUser(String identity, String domainName = null) #
ADPlayground/DirectoryOps/DirectoryAccountHelper.cs:81
Returns: DirectoryMutationResult

Enables a user account by identity.

Parameters

identity System.String requiredposition: 0
The user identity (sAMAccountName, UPN, DN, mail, or name).
domainName System.String = null optionalposition: 1
Optional domain DNS name. When omitted, domain is inferred from identity hints before falling back to current machine context.

Returns

Mutation result describing the action.

public DirectoryMutationResult RemoveGroupMember(String groupIdentity, String memberIdentity, String domainName = null) #
ADPlayground/DirectoryOps/DirectoryAccountHelper.cs:192
Returns: DirectoryMutationResult

Removes a member from a group.

Parameters

groupIdentity System.String requiredposition: 0
The group identity (sAMAccountName, DN, mail, or name).
memberIdentity System.String requiredposition: 1
Member identity (sAMAccountName, UPN, dNSHostName, DN, mail, or name).
domainName System.String = null optionalposition: 2
Optional domain DNS name. When omitted, domain is inferred from group identity hints before falling back to current machine context.

Returns

Mutation result describing the action.

public DirectoryMutationResult ResetComputerPassword(String identity, String newPassword, String domainName = null) #
ADPlayground/DirectoryOps/DirectoryAccountHelper.cs:155
Returns: DirectoryMutationResult

Resets a computer account password by identity.

Parameters

identity System.String requiredposition: 0
The computer identity (sAMAccountName, dNSHostName, DN, or name).
newPassword System.String requiredposition: 1
The new password value.
domainName System.String = null optionalposition: 2
Optional domain DNS name. When omitted, domain is inferred from identity hints before falling back to current machine context.

Returns

Mutation result describing the action.

public DirectoryMutationResult ResetUserPassword(String identity, String newPassword, String domainName = null, Boolean changeAtNextLogon = false) #
ADPlayground/DirectoryOps/DirectoryAccountHelper.cs:142
Returns: DirectoryMutationResult

Resets a user password by identity.

Parameters

identity System.String requiredposition: 0
The user identity (sAMAccountName, UPN, DN, mail, or name).
newPassword System.String requiredposition: 1
The new password value.
domainName System.String = null optionalposition: 2
Optional domain DNS name. When omitted, domain is inferred from identity hints before falling back to current machine context.
changeAtNextLogon System.Boolean = false optionalposition: 3
When set, forces password change at next logon.

Returns

Mutation result describing the action.