Functions/Requests/Remove-PASRequest.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
function Remove-PASRequest {
    <#
.SYNOPSIS
Deletes a request from the Vault
 
.DESCRIPTION
Deletes a request from the Vault.
The "Manage" Safe vault permission is required.
Officially supported from version 9.10. Reports received that function works in 9.9 also.
 
.PARAMETER RequestID
The ID (composed of the Safe Name and internal RequestID.) of the request to delete.
 
.EXAMPLE
Remove-PASRequest -RequestID "<ID>"
 
Deletes Request <ID>
 
.INPUTS
All parameters can be piped by property name
 
.OUTPUTS
None
#>

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

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

    PROCESS {

        Assert-VersionRequirement -ExternalVersion $Script:ExternalVersion -RequiredVersion $MinimumVersion

        #Create URL for request
        $URI = "$Script:BaseURI/API/MyRequests/$($RequestID)"

        if($PSCmdlet.ShouldProcess($RequestID, "Delete Request")) {

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

        }

    }#process

    END { }#end
}