Get-VPASAccountDetailsExtended


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

GET ACCOUNT EXTENDED DETAILS


Description:

USE THIS FUNCTION TO GET EXTENDED DETAILS OF AN ACCOUNT IN CYBERARK


Syntax:

Get-VPASAccountDetailsExtended [-safe <String>] [-platform <String>] [-username <String>] [-address <String>] [-ExactMatch] [-HideWarning] [-ExportToCSV] [-CSVDirectory <String>] [-token <Hashtable>] [<CommonParameters>]

Get-VPASAccountDetailsExtended -AcctID <String> [-ExportToCSV] [-CSVDirectory <String>] [-token <Hashtable>] [<CommonParameters>]

Get-VPASAccountDetailsExtended -InputParameters <Hashtable> [-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: named
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: named
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: named
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: named
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: true
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-ExactMatch [<SwitchParameter>]
Returns accounts that match search query exactly (not a wildcard search)

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

-HideWarning [<SwitchParameter>]
Hide any warning outputs from the console during the API session

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

-InputParameters <Hashtable>
HashTable of values containing the parameters required to make the API call

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

-ExportToCSV [<SwitchParameter>]
Output results to a CSV file found in AppData\Local\VPASModuleOutputs directory

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

-CSVDirectory <String>
Output directory where the exported CSV file will be saved to
Default value: C:\Users\{CurrentUser}\AppData\Local\VPASModuleOutputs\ExportedCSVs

Required: false
Position: named
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: named
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:

$AccountDetailsExtendedJSON = Get-VPASAccountDetailsExtended -safe {SAFE VALUE} -username {USERNAME VALUE}

$AccountDetailsExtendedJSON = Get-VPASAccountDetailsExtended -AcctID {ACCTID VALUE}

$InputParameters = @{
        AcctID = 3_12
         ExportToCSV = $true|$false
         CSVDirectory = "C:\Temp"
}
$AccountDetailsExtendedJSON = Get-VPASAccountDetailsExtended -InputParameters $InputParameters

$InputParameters = @{
        safe = "TargetSafeName"
         platform = "TargetPlatformID"
         username = "TargetUsername"
         address = "TargetAddress"
         ExactMatch = $true|$false
         HideWarning = $true|$false
         ExportToCSV = $true|$false
         CSVDirectory = "C:\Temp"
}
$AccountDetailsExtendedJSON = Get-VPASAccountDetailsExtended -InputParameters $InputParameters


Outputs:

If successful:
{
         "Compliance": {
                 "IsCompliant": false,
                 "LastModifiedDate": 1715222718,
                 "LastModifiedBy": "vadim@vman.com",
                 "ModificationType": "Change"
         },
         "Activities": [
                 ...
                 {
                         "Alert": false,
                         "Date": 1735008158,
                         "User": "vpasuser@vman.com",
                         "Action": "Get File Request",
                         "ActionID": 109,
                         "ClientID": "PVWA",
                         "MoreInfo": "",
                 "Reason": "give me access [From 12/24/2024 2:42:38 AM to 1/23/2025 2:42:38 AM ]"
                 },
                 ...
         ],
         "TotalDependencies": 0,
         "FailedDependencies": 0,
         "Recordings": null,
         "Details": {
                 "LastVerifiedDate": 0,
                 "LastVerifiedBy": null,
                 "LastUsedBy": "vadim@vman.cpm",
                 "LastUsedDate": 1715222731,
                 "CreationDate": 1715222718,
                 "Name": "Operating System-VPASDualControl-vman.com-DomainAdmin01",
                 "CreatedTime": 1715222718,
                 "AccountURL": null,
                 "ManagedByCPM": true,
                 "CPMDisabled": "",
                 "CPMStatus": null,
                 "CPMErrorDetails": "",
                 "ImmediateCPMTask": null,
                 "DeletedBy": "",
                 "DeletionDate": 0,
                 "LockedBy": "",
                 "IsFavorite": false,
                 "IsNew": false,
                 "SafeName": "VPASRequestSafe",
                 "IsGroupMember": false,
                 "DualControlStatus": "RequestNeeded",
                 "RequiredProperties": {
                         "Address": "vman.com",
                         "Username": "DomainAdmin01"
                 },
                 "OptionalProperties": null,
                 "LimitDomainAccess": "",
                 "AccessDomainList": "",
                 "RequestId": -1,
                 "FutureTimeFrame": false,
                 "LinkedAccounts": null
         },
         "Platform": {
                 "VerificationPeriod": 7,
                 "ExpirationPeriod": 90,
                 "HeadStartInterval": 5,
                 "PlatformID": "VPASDualControl",
                 "PlatformName": "VPASDualControl",
                 "IsActive": true
         },
         "AvailableTabs": [
                 "Activities",
                 "Dependencies"
         ],
         "ActionsToDisplay": null
}

$false if failed