psPAS

5.5.110

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
 # .ExternalHelp psPAS-help.xml
function Remove-PASAccount {
    [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSReviewUnusedParameter', 'UseGen1API', Justification = 'False Positive')]
    [CmdletBinding(SupportsShouldProcess)]
    param(
        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true
        )]
        [ValidateNotNullOrEmpty()]
        [Alias('id')]
        [string]$AccountID,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $false,
            ParameterSetName = 'Gen1'
        )]
        [Alias('UseClassicAPI')]
        [switch]$UseGen1API
    )

    BEGIN {
        #check minimum version
        Assert-VersionRequirement -RequiredVersion 10.4
    }#begin

    PROCESS {

        switch ($PSCmdlet.ParameterSetName) {

            'Gen1' {

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

            }

            default {

                #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

}