TestimoX

API Reference

Command

Remove-ADXUser

Namespace ADPlayground.PowerShell
Outputs
ADPlayground.DirectoryMutationResult

Removes an Active Directory user account.

Examples

Authored help example

Example 1: Preview the removal of a lab user account


Remove-ADXUser -Identity 'lab.temp01' -Domain 'contoso.com' -WhatIf
        

Example 2: Remove a deprovisioned contractor account after review


Remove-ADXUser -Identity 'anna.kowalska' -Domain 'contoso.com' -Confirm:$false
        

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.

Syntax

Remove-ADXUser -Identity <string> [-Domain <string>] [<CommonParameters>]
#

Parameters

Identity string requiredposition: 0pipeline: falsealiases: CommonName, DistinguishedName, DN, Mail, Name, SamAccountName, UPN, UserPrincipalName
Gets or sets user identity (sAMAccountName, UPN, DN, mail, or name).
Domain string optionalposition: namedpipeline: falsealiases: DomainName
Gets or sets the optional domain DNS name.

Outputs

ADPlayground.DirectoryMutationResult