Functions/EventSecurity/Set-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
Function Set-PASPTAEvent {
    <#
.SYNOPSIS
Updates the status of a security event

.DESCRIPTION
Updates the status of a security event to open or closed

.PARAMETER EventID
The event ID.

.PARAMETER mStatus
The status to update (open or closed).

.EXAMPLE
Set-PASPTAEvent -EventID $id

.NOTES
Minimum Version CyberArk 11.3

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

    [CmdletBinding()]
    param(
        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true
        )]
        [string]$EventID,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true
        )]
        [ValidateSet("OPEN","CLOSED")]
        [string]$mStatus

    )

    BEGIN {
        $MinimumVersion = [System.Version]"11.3"

    }#begin

    PROCESS {

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

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

        #Get Parameters to include in request
        $body = $PSBoundParameters | Get-PASParameter -ParametersToRemove EventID | ConvertTo-Json

        #Send request to web service
        $result = Invoke-PASRestMethod -Uri $URI -Method PATCH -Body $body

        If ($result) {

            #Return Results
            $result |

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

        }

    }#process

    END { }#end

}