psPAS

5.5.110

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

                                # .ExternalHelp psPAS-help.xml

Function Set-PASPTAEvent {

    [CmdletBinding(SupportsShouldProcess)]

    param(

        [parameter(

            Mandatory = $true,

            ValueFromPipelinebyPropertyName = $true

        )]

        [string]$EventID,

        [parameter(

            Mandatory = $false,

            ValueFromPipelinebyPropertyName = $true

        )]

        [ValidateSet('OPEN', 'CLOSED')]

        [string]$mStatus

    )

    BEGIN {

        Assert-VersionRequirement -RequiredVersion 11.3

    }#begin

    PROCESS {

        #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

        if ($PSCmdlet.ShouldProcess($EventID, 'Update Event Status')) {

            #Send request to web service

            $result = Invoke-PASRestMethod -Uri $URI -Method PATCH -Body $body

        }

        If ($null -ne $result) {

            #Return Results

            $result | Add-ObjectDetail -typename psPAS.CyberArk.Vault.PTA.Event

        }

    }#process

    END { }#end

}