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
function Remove-PASUser {
    <#
.SYNOPSIS
Deletes a vault user

.DESCRIPTION
Deletes an existing user from the vault

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

.EXAMPLE
Remove-PASUser This_User

Deletes vault user "This_User"

.INPUTS
All parameters can be piped by property name

.OUTPUTS
None
#>

    [CmdletBinding(SupportsShouldProcess)]
    param(
        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true
        )]
        [string]$UserName
    )

    BEGIN {}#begin

    PROCESS {

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

            Get-EscapedString)"


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

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

        }

    }#process

    END {}#end
}