GET ACCOUNT DETAILS

USE THIS FUNCTION TO GET DETAILS OF AN ACCOUNT IN CYBERARK

Get-VPASAccountDetails [-safe <String>] [-platform <String>] [-username <String>] [-address <String>] [-token <Hashtable>] [-ExactMatch] [-HideWarning] [-SavedFilter <String>] [<CommonParameters>]

Get-VPASAccountDetails -AcctID <String> [-token <Hashtable>] [<CommonParameters>]

Get-VPASAccountDetails [-token <Hashtable>] -InputParameters <Hashtable> [<CommonParameters>]

-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

-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

-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

-SavedFilter <String>
Returns accounts based on a prebuilt search query
Possible values: "Regular", "Recently", "New", "Link", "Deleted", "PolicyFailures", "AccessedByUsers", "ModifiedByUsers", "ModifiedByCPM", "DisabledPasswordByUser", "DisabledPasswordByCPM", "ScheduledForChange", "ScheduledForVerify", "ScheduledForReconcile", "SuccessfullyReconciled", "FailedChange", "FailedVerify", "FailedReconcile", "LockedOrNew", "Locked", "Favorites"

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)

$AccountDetailsJSON = Get-VPASAccountDetails -safe {SAFE VALUE} -username {USERNAME VALUE}

$AccountDetailsJSON = Get-VPASAccountDetails -AcctID {ACCTID VALUE}

$InputParameters = @{
        AcctID = 3_12
}
$AccountDetailsJSON = Get-VPASAccountDetails -InputParameters $InputParameters

$InputParameters = @{
        safe = "TargetSafeName"
         platform = "TargetPlatformID"
         username = "TargetUsername"
         address = "TargetAddress"
         ExactMatch = $true|$false
         HideWarning = $true|$false
         SavedFilter =
        "Regular"|"Recently"|"New"|"Link"|"Deleted"|"PolicyFailures"|"AccessedByUsers"|"ModifiedByUsers"|"ModifiedByCPM"|"DisabledPasswordByUser"|"DisabledPasswordByCPM"|"ScheduledForChange"|"ScheduledForVerify"|"ScheduledForReconcile"|"SuccessfullyReconciled"|"FailedChange"|"FailedVerify"|"FailedReconcile"|"LockedOrNew"|"Locked"|"Favorites"
}
$AccountDetailsJSON = Get-VPASAccountDetails -InputParameters $InputParameters

If successful:
{
         "categoryModificationTime": 1715701023,
         "platformId": "VPASDualControl",
         "safeName": "VPASRequestSafe",
         "id": "120_3",
         "name": "Operating System-VPASDualControl-vman.com-DomainAdmin01",
         "address": "vman.com",
         "userName": "DomainAdmin011",
         "secretType": "password",
         "secretManagement": {
                 "automaticManagementEnabled": true,
                 "lastModifiedTime": 1715222718
         },
         "createdTime": 1715222718
}

$false if failed