public/Get-VPASAllIncomingRequests.ps1

<#
.Synopsis
   GET ALL INCOMING REQUESTS
   CREATED BY: Vadim Melamed, EMAIL: vmelamed5@gmail.com
.DESCRIPTION
   USE THIS FUNCTION TO RETRIEVE ALL INCOMING REQUESTS MADE BY USERS
.PARAMETER token
   HashTable of data containing various pieces of login information (PVWA, LoginToken, HeaderType, etc).
   If -token is not passed, function will use last known hashtable generated by New-VPASToken
.PARAMETER IncludeExpiredRequests
   Switch if to include incoming requests that have already expired
.PARAMETER OnlyPendingRequests
   Switch if to only return incoming requests that are still pending an approval
.EXAMPLE
   $AllIncomingRequestsJSON = Get-VPASAllIncomingRequests -IncludeExpiredRequests
.OUTPUTS
   If successful:
   {
        "IncomingRequests": [
                                 {
                                     "RequestorFullName": "vadim",
                                     "RequestID": "VPASRequestSafe_20",
                                     "SafeName": "VPASRequestSafe",
                                     "RequestorUserName": "vadim@vman.com",
                                     "RequestorReason": "(ConnectionClient=PSM-RDP) Testing Account Request",
                                     "UserReason": "Testing Account Request",
                                     "CreationDate": 1724125545,
                                     "Operation": "Connect to VPASDualControl-DomainAdmin011-vman.com",
                                     "ExpirationDate": 1726717545,
                                     "OperationType": 4,
                                     "AccessType": "ManyTimes",
                                     "ConfirmationsLeft": 1,
                                     "AccessFrom": 1724158800,
                                     "AccessTo": 1724173200,
                                     "Status": 1,
                                     "StatusTitle": "Waiting: 1 more user(s) must confirm the request",
                                     "InvalidRequestReason": 0,
                                     "CurrentConfirmationLevel": 1,
                                     "RequiredConfirmersCountLevel2": 1,
                                     "TicketingSystemProperties": "@{Name=; Number=; Status=}",
                                     "AdditionalInfo": "",
                                     "AccountDetails": "@{AccountID=120_3; Properties=}",
                                     "Confirmers": ""
                                 }
                             ],
        "Total": 1
   }
   ---
   $false if failed
#>

function Get-VPASAllIncomingRequests{
    [OutputType('System.Collections.Hashtable',[bool])]
    [CmdletBinding()]
    Param(
        [Parameter(Mandatory=$false,ValueFromPipelineByPropertyName=$true,Position=0)]
        [switch]$IncludeExpiredRequests,

        [Parameter(Mandatory=$false,ValueFromPipelineByPropertyName=$true,Position=1)]
        [switch]$OnlyPendingRequests,

        [Parameter(Mandatory=$false,ValueFromPipelineByPropertyName=$true,Position=2)]
        [hashtable]$token
    )

    Begin{
        $tokenval,$sessionval,$PVWA,$Header,$ISPSS,$IdentityURL,$EnableTextRecorder,$AuditTimeStamp,$NoSSL,$VaultVersion,$HideWarnings,$AuthenticatedAs,$SubDomain = Get-VPASSession -token $token
        $CommandName = $MyInvocation.MyCommand.Name
        $log = Write-VPASTextRecorder -inputval $CommandName -token $token -LogType COMMAND
    }
    Process{
        Write-Verbose "SUCCESSFULLY PARSED PVWA VALUE"
        Write-Verbose "SUCCESSFULLY PARSED TOKEN VALUE"

        try{

            write-verbose "MAKING API CALL TO CYBERARK"

            if($NoSSL){
                Write-Verbose "NO SSL ENABLED, USING HTTP INSTEAD OF HTTPS"
                $uri = "http://$PVWA/PasswordVault/API/IncomingRequests?"
            }
            else{
                Write-Verbose "SSL ENABLED BY DEFAULT, USING HTTPS"
                $uri = "https://$PVWA/PasswordVault/API/IncomingRequests?"
            }
            if($IncludeExpiredRequests){
                $uri += "expired=$true&"
            }
            if($OnlyPendingRequests){
                $uri += "onlywaiting=$true&"
            }
            $uri = $uri.Substring(0,($uri.Length-1))

            $log = Write-VPASTextRecorder -inputval $uri -token $token -LogType URI
            $log = Write-VPASTextRecorder -inputval "GET" -token $token -LogType METHOD

            if($sessionval){
                $response = Invoke-RestMethod -Headers @{"Authorization"=$Header} -Uri $uri -Method GET -ContentType "application/json" -WebSession $sessionval
            }
            else{
                $response = Invoke-RestMethod -Headers @{"Authorization"=$Header} -Uri $uri -Method GET -ContentType "application/json"
            }
            $log = Write-VPASTextRecorder -inputval $response -token $token -LogType RETURNARRAY

            Write-Verbose "PARSING DATA FROM CYBERARK"
            Write-Verbose "RETURNING JSON OBJECT"
            return $response
        }catch{
            $log = Write-VPASTextRecorder -inputval $_ -token $token -LogType ERROR
            $log = Write-VPASTextRecorder -inputval "REST API COMMAND RETURNED: FALSE" -token $token -LogType MISC
            Write-Verbose "FAILED TO RETRIEVE INCOMING REQUESTS"
            Write-VPASOutput -str $_ -type E
            return $false
        }
    }
    End{
        $log = Write-VPASTextRecorder -inputval $CommandName -token $token -LogType DIVIDER
    }
}