Functions/Requests/Get-PASRequest.ps1
|
function Get-PASRequest { <# .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 OnlyWaiting Only requests waiting for approval will be listed .PARAMETER Expired Expired requests will be included in the list .PARAMETER sessionToken Hashtable containing the session token returned from New-PASSession .PARAMETER WebSession WebRequestSession object returned from New-PASSession .PARAMETER BaseURI PVWA Web Address Do not include "/PasswordVault/" .PARAMETER PVWAAppName The name of the CyberArk PVWA Virtual Directory. Defaults to PasswordVault .PARAMETER ExternalVersion The External CyberArk Version, returned automatically from the New-PASSession function from version 9.7 onwards. If the minimum version requirement of this function is not satisfied, execution will be halted. Omitting a value for this parameter, or supplying a version of "0.0" will skip the version check. .EXAMPLE Get-PASRequest -RequestType IncomingRequests -OnlyWaiting $true -sessionToken $token -BaseURI $url Lists waiting incoming requests .EXAMPLE Get-PASRequest -RequestType MyRequests -Expired $false -sessionToken $token.sessiontoken -BaseURI $token.url Lists your none expired (outgoing) requests. .INPUTS All parameters can be piped by property name .OUTPUTS SessionToken, WebSession, BaseURI are passed through and contained in output object for inclusion in subsequent pipeline operations. 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 #> [CmdletBinding()] param( [parameter( Mandatory = $true, ValueFromPipelinebyPropertyName = $true )] [ValidateNotNullOrEmpty()] [ValidateSet("MyRequests", "IncomingRequests")] [string]$RequestType, [parameter( Mandatory = $true, ValueFromPipelinebyPropertyName = $true )] [boolean]$OnlyWaiting, [parameter( Mandatory = $true, ValueFromPipelinebyPropertyName = $true )] [boolean]$Expired, [parameter( Mandatory = $true, ValueFromPipelinebyPropertyName = $true )] [ValidateNotNullOrEmpty()] [hashtable]$sessionToken, [parameter( ValueFromPipelinebyPropertyName = $true )] [Microsoft.PowerShell.Commands.WebRequestSession]$WebSession, [parameter( Mandatory = $true, ValueFromPipelinebyPropertyName = $true )] [string]$BaseURI, [parameter( Mandatory = $false, ValueFromPipelinebyPropertyName = $true )] [string]$PVWAAppName = "PasswordVault", [parameter( Mandatory = $false, ValueFromPipelinebyPropertyName = $true )] [System.Version]$ExternalVersion = "0.0" ) BEGIN { $MinimumVersion = [System.Version]"9.10" }#begin PROCESS { Assert-VersionRequirement -ExternalVersion $ExternalVersion -RequiredVersion $MinimumVersion #Create URL for Request $URI = "$baseURI/$PVWAAppName/API/$($RequestType)?onlywaiting=$OnlyWaiting&expired=$Expired" #send request to PAS web service $result = Invoke-PASRestMethod -Uri $URI -Method GET -Headers $sessionToken -WebSession $WebSession If($result) { #Return Results $result.$RequestType | Add-ObjectDetail -typename psPAS.CyberArk.Vault.Request.Details -PropertyToAdd @{ "sessionToken" = $sessionToken "WebSession" = $WebSession "BaseURI" = $BaseURI "PVWAAppName" = $PVWAAppName "ExternalVersion" = $ExternalVersion } } }#process END { }#end } |