Functions/User/Remove-PASUser.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
# .ExternalHelp psPAS-help.xml
function Remove-PASUser {
    [CmdletBinding(SupportsShouldProcess, DefaultParameterSetName = "Gen2")]
    param(

        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "Gen2"
        )]
        [int]$id,

        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "Gen1"
        )]
        [string]$UserName
    )

    BEGIN {

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

            Assert-VersionRequirement -RequiredVersion 11.1

        }

    }#begin

    PROCESS {

        switch ($PSCmdlet.ParameterSetName) {

            "Gen2" {

                $URI = "$Script:BaseURI/api/Users/$id"

                break

            }

            default {

                #Create URL for request
                $URI = "$Script:BaseURI/WebServices/PIMServices.svc/Users/$($UserName | Get-EscapedString)"

                break

            }

        }

        if ($PSCmdlet.ShouldProcess($UserName, "Delete User")) {

            #send request to web service
            Invoke-PASRestMethod -Uri $URI -Method DELETE -WebSession $Script:WebSession

        }

    }#process

    END { }#end
}