Functions/Accounts/Remove-PASAccount.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
function Remove-PASAccount {
    <#
.SYNOPSIS
Deletes an account
 
.DESCRIPTION
Deletes a specific account in the Vault.
The user who runs this web service requires the "Delete Accounts" permission.
 
.PARAMETER AccountID
The unique ID of the account to delete.
This is retrieved by the Get-PASAccount function.
 
.PARAMETER UseClassicAPI
Specify the UseClassicAPI to force usage the Classic API endpoint.
Relevant for CyberArk versions earlier than 10.4
 
.EXAMPLE
Remove-PASAccount -AccountID 19_1
 
Deletes the account with AccountID of 19_1
 
.INPUTS
All parameters can be piped by propertyname
 
 
.LINK
https://pspas.pspete.dev/commands/Remove-PASAccount
#>

    [CmdletBinding(SupportsShouldProcess)]
    param(
        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true
        )]
        [ValidateNotNullOrEmpty()]
        [Alias("id")]
        [string]$AccountID,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $false,
            ParameterSetName = "v9"
        )]
        [switch]$UseClassicAPI
    )

    BEGIN {
        $MinimumVersion = [System.Version]"10.4"
    }#begin

    PROCESS {

        If ($PSCmdlet.ParameterSetName -eq "V9") {

            #Create URL for request (earlier than 10.4)
            $URI = "$Script:BaseURI/WebServices/PIMServices.svc/Accounts/$AccountID"

        }

        Else {

            #check minimum version
            Assert-VersionRequirement -ExternalVersion $Script:ExternalVersion -RequiredVersion $MinimumVersion

            #Create URL for request (Version 10.4 onwards)
            $URI = "$Script:BaseURI/api/Accounts/$AccountID"

        }

        if ($PSCmdlet.ShouldProcess($AccountID, "Delete Account")) {

            #Send request to webservice
            Invoke-PASRestMethod -Uri $URI -Method DELETE -WebSession $Script:WebSession

        }

    }#process

    END { }#end
}