Get-VPASAccountActivity


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

GET ACCOUNT ACTIVITY


Description:

USE THIS FUNCTION TO GET THE ACTIVITY OF AN ACCOUNT


Syntax:

Get-VPASAccountActivity [[-safe] <String>] [[-platform] <String>] [[-username] <String>] [[-address] <String>] [[-AcctID] <String>] [[-token] <Hashtable>] [<CommonParameters>]


Parameters:

-safe <String>
Safe name that will be used to query for the target account if no AcctID is passed

Required: false
Position: 1
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-platform <String>
PlatformID that will be used to query for the target account if no AcctID is passed

Required: false
Position: 2
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-username <String>
Username that will be used to query for the target account if no AcctID is passed

Required: false
Position: 3
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-address <String>
Address that will be used to query for the target account if no AcctID is passed

Required: false
Position: 4
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-AcctID <String>
Unique ID that maps to a single account, passing this variable will skip any query functions

Required: false
Position: 5
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-token <Hashtable>
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

Required: false
Position: 6
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug
ErrorAction, ErrorVariable, WarningAction, WarningVariable
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216)


Examples:

$AccountActivityJSON = Get-VPASAccountActivity -safe {SAFE VALUE} -username {USERNAME VALUE} -platform {PLATFORM VALUE} -address {ADDRESS VALUE}

$AccountActivityJSON = Get-VPASAccountActivity -AcctID {ACCTID VALUE}


Outputs:

If successful:
{
         "Activities": [
                 {
                         "Alert": false,
                         "Date": 1723776151,
                         "User": "vman@cyberark.cloud.1234",
                         "Action": "Get File Request",
                         "ActionID": 109,
                         "ClientID": "PVWA",
                         "MoreInfo": "",
                 "Reason": "(ConnectionClient=PSM-RDP) Testing Account Request [From 8/16/2024 1:00:00 PM to 8/16/2024 5:00:00 PM multiple operations]"
                 },
                 {
                         "Alert": true,
                         "Date": 1716701723,
                         "User": "vman@cyberark.cloud.1234",
                         "Action": "Retrieve File",
                         "ActionID": 43,
                         "ClientID": "PVWA",
                         "MoreInfo": "",
                         "Reason": ""
                 },
                 {
                         "Alert": false,
                         "Date": 1715651891,
                         "User": "normaluser@vman.com",
                         "Action": "Get File Request",
                         "ActionID": 109,
                         "ClientID": "PVWA",
                         "MoreInfo": "",
                 "Reason": "testing bulk request via apis [From 5/14/2024 1:58:11 AM to 6/13/2024 1:58:11 AM ]"
                 },
                 {
                         "Alert": false,
                         "Date": 1715222731,
                         "User": "vadim@vman.pam",
                         "Action": "Retrieve password",
                         "ActionID": 295,
                         "ClientID": "PVWA",
                         "MoreInfo": "",
                         "Reason": "(Action: Show Password)"
                 }
         ],
         "Total": 4
}

$false if failed