Functions/Requests/Get-PASRequestDetail.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
function Get-PASRequestDetail {
    <#
.SYNOPSIS
Gets requests
 
.DESCRIPTION
Gets Requests
Officially supported from version 9.10. Reports received that function works in 9.9 also.
 
.PARAMETER RequestType
Specify whether outgoing or incoming requests will be searched for
 
.PARAMETER RequestID
The request's uniqueID, composed of the Safe Name and internal RequestID.
 
.PARAMETER OnlyWaiting
Only requests waiting for approval will be listed
 
.PARAMETER Expired
Expired requests will be included in the list
 
.EXAMPLE
Get-PASRequestDetail -RequestType IncomingRequests -RequestID $ID
 
Gets details of request with ID held in $ID
 
.INPUTS
All parameters can be piped by property name
 
.OUTPUTS
Output format is defined via psPAS.Format.ps1xml.
To force all output to be shown, pipe to Select-Object *
 
.NOTES
Minimum CyberArk Version 9.10
 
.LINK
https://pspas.pspete.dev/commands/Get-PASRequestDetail
#>

    [CmdletBinding()]
    param(
        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true
        )]
        [ValidateNotNullOrEmpty()]
        [ValidateSet("MyRequests", "IncomingRequests")]
        [string]$RequestType,

        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true
        )]
        [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/$($RequestType)/$($RequestID)"

        #send request to PAS web service
        $result = Invoke-PASRestMethod -Uri $URI -Method GET -WebSession $Script:WebSession

        If ($result) {

            #Return Results
            $result |

            Add-ObjectDetail -typename psPAS.CyberArk.Vault.Request.Extended

        }

    }#process

    END { }#end

}