Functions/Requests/Approve-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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
function Approve-PASRequest {
    <#
.SYNOPSIS
Confirm a single request

.DESCRIPTION
Enables a request confirmer to confirm a single request, identified by its requestID.
Officially supported from version 9.10. Reports received that function works in 9.9 also.

.PARAMETER RequestId
The ID of the request to confirm

.PARAMETER reason
The reason why the request is approved

.EXAMPLE
Approve-PASRequest -RequestID <ID> - Reason "<Reason>"

Confirms request <ID>

.INPUTS
All parameters can be piped by property name

.OUTPUTS
None

.NOTES
Minimum CyberArk Version 9.10

.LINK
https://pspas.pspete.dev/commands/Approve-PASRequest
#>

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

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true
        )]
        [string]$Reason
    )

    BEGIN {
        Assert-VersionRequirement -RequiredVersion 9.10
    }#begin

    PROCESS {

        #Create URL for Request
        $URI = "$Script:BaseURI/API/IncomingRequests/$($RequestID)/Confirm"

        #Create body of request
        $body = $PSBoundParameters | Get-PASParameter -ParametersToRemove RequestId | ConvertTo-Json

        if ($PSCmdlet.ShouldProcess($RequestId, "Confirm Request for Account Access")) {

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

        }

    }#process

    END { }#end

}