Functions/LDAPDirectories/Remove-PASDirectory.ps1
|
function Remove-PASDirectory { <# .SYNOPSIS Removes an LDAP directory configured in the Vault .DESCRIPTION Removes an LDAP directory configuration from the vault. Membership of the Vault Admins group required. .PARAMETER id The ID or Name of the directory to return information on. .PARAMETER sessionToken Hashtable containing the session token returned from New-PASSession .PARAMETER WebSession WebRequestSession object returned from New-PASSession .PARAMETER BaseURI PVWA Web Address Do not include "/PasswordVault/" .PARAMETER PVWAAppName The name of the CyberArk PVWA Virtual Directory. Defaults to PasswordVault .PARAMETER ExternalVersion The External CyberArk Version, returned automatically from the New-PASSession function from version 9.7 onwards. If the minimum version requirement of this function is not satisfied, execution will be halted. Omitting a value for this parameter, or supplying a version of "0.0" will skip the version check. .EXAMPLE $token | Remove-PASDirectory -id LDAPDirectory Removes LDAP directory configured in the Vault .INPUTS WebSession & BaseURI can be piped to the function by propertyname .OUTPUTS LDAP Directory Details .NOTES .LINK #> [CmdletBinding(SupportsShouldProcess = $true)] param( [parameter( Mandatory = $true, ValueFromPipelinebyPropertyName = $true )] [Alias("DomainName")] [string]$id, [parameter( Mandatory = $true, ValueFromPipelinebyPropertyName = $true )] [ValidateNotNullOrEmpty()] [hashtable]$sessionToken, [parameter( Mandatory = $false, ValueFromPipelinebyPropertyName = $true )] [Microsoft.PowerShell.Commands.WebRequestSession]$WebSession, [parameter( Mandatory = $true, ValueFromPipelinebyPropertyName = $true )] [string]$BaseURI, [parameter( Mandatory = $false, ValueFromPipelinebyPropertyName = $true )] [string]$PVWAAppName = "PasswordVault", [parameter( Mandatory = $false, ValueFromPipelinebyPropertyName = $true )] [System.Version]$ExternalVersion = "0.0" ) BEGIN { $MinimumVersion = [System.Version]"10.7" }#begin PROCESS { Assert-VersionRequirement -ExternalVersion $ExternalVersion -RequiredVersion $MinimumVersion #Create URL for request $URI = "$baseURI/$PVWAAppName/api/Configuration/LDAP/Directories/$id" if($PSCmdlet.ShouldProcess($id, "Delete Directory")) { #send request to web service Invoke-PASRestMethod -Uri $URI -Method DELETE -Headers $sessionToken -WebSession $WebSession } }#process END { }#end } |