Public/Invoke-RiskSenseFindingExport.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 Invoke-RiskSenseFindingExport {
    <#
    .SYNOPSIS
        Initiate export job
    .DESCRIPTION
        Endpoint for initiating an export job against the data outlined in the given FilterRequest
        Authority: User, Group Manager, Manager
    .EXAMPLE
        Invoke-RiskSenseFindingExport -ClientID 1 -Token 'secrettoken'
    #>


    [CmdletBinding()]
    param(
        # ClientID
        [Parameter(Mandatory)]
        [int]$ClientID,

        # Filter on "Status"
        [ValidateSet('Open', 'Closed')]
        [string]$Status,

        # Filter on "Has Patch"
        [AllowNull()]
        [nullable[bool]]$HasPatch,

        # Filter on "Has Privilege Escalation or Remote Code Execution Exploits"
        [AllowNull()]
        [nullable[bool]]$HasPeRce,
        
        # RiskSense API Key
        [Parameter(Mandatory)]
        $Token
    )

    begin {
        $headers = Get-AuthHeader $Token
        $filters = @()

        if ($Status) {
            $filters += [PSCustomObject]@{
                field = 'generic_state'
                exclusive = $false
                operator = 'EXACT'
                value = $Status
            }
        }

        if ($HasPeRce -ne $null) {
            $filters += [PSCustomObject]@{
                field = 'has_pe_rce'
                exclusive = $false
                operator = 'EXACT'
                value = ([string]$HasPeRce).ToLower()
            }
        }

        if ($HasPatch -ne $null) {
            $filters += [PSCustomObject]@{
                field = 'has_patch'
                exclusive = $false
                operator = 'EXACT'
                value = ([string]$HasPatch).ToLower()
            }
        }

        $body = [PSCustomObject]@{
            filterRequest = [PSCustomObject]@{
                filters = $filters 
            }
            fileType = 'XLSX'
        } | ConvertTo-Json -Depth 99
    }

    process {
        $result = Invoke-RestMethod -Uri "$uri/client/$ClientID/hostFinding/export" -Method Post -Body $body -Headers $headers
        [PSCustomObject]@{
            ID = $result.id
            Created = Get-Date $result.created
        }
    }

    end {}
}