Functions/EventSecurity/Get-PASPTAEvent.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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
Function Get-PASPTAEvent {
    <#
.SYNOPSIS
Returns PTA security events

.DESCRIPTION
Returns PTA security events

.PARAMETER lastUpdatedEventDate
Starting date from which to get security events.

.PARAMETER status
The status of the security event (open or closed).
Requires 11.4

.PARAMETER accountID
The unique account identifier of the account relating to the Security Event.
Requires 11.4

.PARAMETER UseLegacyMethod
Specify to send lastUpdatedEventDate using legacy method
Requires 11.4

.EXAMPLE
Get-PASPTAEvent

Returns all PTA security events

.EXAMPLE
Get-PASPTAEvent -lastUpdatedEventDate $date

Returns all PTA security events since $date

.EXAMPLE
Get-PASPTAEvent -status OPEN

Returns all PTA security events with an Open status.

.EXAMPLE
Get-PASPTAEvent -lastUpdatedEventDate $date -UseLegacyMethod

Returns all PTA security events since $date

.NOTES
Minimum Version CyberArk 10.3

.LINK
https://pspas.pspete.dev/commands/Get-PASPTAEvent
#>

    [CmdletBinding(DefaultParameterSetName = "11_4")]
    param(
        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "11_4"
        )]

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "10_3"
        )]
        [datetime]$lastUpdatedEventDate,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "11_4"
        )]
        [ValidateSet("OPEN", "CLOSED")]
        [string]$status,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "11_4"
        )]
        [string]$accountID,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $false,
            ParameterSetName = "10_3"
        )]
        [switch]$UseLegacyMethod

    )

    BEGIN {
        $MinimumVersion = [System.Version]"10.3"
        $RequiredVersion = [System.Version]"11.4"

    }#begin

    PROCESS {

        Assert-VersionRequirement -ExternalVersion $Script:ExternalVersion -RequiredVersion $MinimumVersion

        #Create request URL
        $URI = "$Script:BaseURI/API/pta/API/Events/"

        #Get Parameters to include in request
        $boundParameters = $PSBoundParameters | Get-PASParameter

        $ThisSession = $Script:WebSession

        if ($PSBoundParameters.ContainsKey("lastUpdatedEventDate")) {

            #add Unix Time Stamp of lastUpdatedEventDate to header as key=value pair
            $boundParameters["lastUpdatedEventDate"] = [math]::Round(($(Get-Date $(Get-Date $lastUpdatedEventDate) -UFormat %s)))

        }

        if ($PSCmdlet.ParameterSetName -eq "11_4") {

            Assert-VersionRequirement -ExternalVersion $Script:ExternalVersion -RequiredVersion $RequiredVersion

            #Create Query String, escaped for inclusion in request URL
            $queryString = $boundParameters | ConvertTo-QueryString

            if ($queryString) {

                #Build URL from base URL
                $URI = "$URI`?$queryString"

            }

        }
        Else {

            if ($PSBoundParameters.ContainsKey("lastUpdatedEventDate")) {

                #add Unix Time Stamp of lastUpdatedEventDate to header as key=value pair
                $ThisSession.Headers["lastUpdatedEventDate"] = $boundParameters["lastUpdatedEventDate"]

            }

        }

        #Send request to web service
        $result = Invoke-PASRestMethod -Uri $URI -Method GET -WebSession $ThisSession

        If ($result) {

            #Return Results
            $result |

            Add-ObjectDetail -typename psPAS.CyberArk.Vault.PTA.Event

        }

    }#process

    END { }#end

}