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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
function Remove-PASUser {
    <#
.SYNOPSIS
Deletes a vault user

.DESCRIPTION
Deletes an existing user from the vault

.PARAMETER id
The numeric id of the user to delete.
Requires CyberArk version 11.1+

.PARAMETER UserName
The name of the user to delete from the vault

.EXAMPLE
Remove-PASUser -id 1234

Deletes vault user with id 1234

.EXAMPLE
Remove-PASUser -UserName This_User

Deletes vault user "This_User"

.INPUTS
All parameters can be piped by property name

.LINK
https://pspas.pspete.dev/commands/Remove-PASUser
#>

    [CmdletBinding(SupportsShouldProcess, DefaultParameterSetName = "11.1")]
    param(

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

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

    BEGIN {

        If ($PSCmdlet.ParameterSetName -ne "legacy") {

            Assert-VersionRequirement -RequiredVersion $PSCmdlet.ParameterSetName

        }

    }#begin

    PROCESS {

        switch ($PSCmdlet.ParameterSetName) {

            "11.1" {

                $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
}