public/Get-VPASAllAccounts.ps1
|
<#
.Synopsis GET ALL ACCOUNTS CREATED BY: Vadim Melamed, EMAIL: vpasmodule@gmail.com .DESCRIPTION USE THIS FUNCTION TO GET ALL ACCOUNTS IN CYBERARK .LINK https://vpasmodule.com/commands/Get-VPASAllAccounts .PARAMETER token 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 .PARAMETER InputParameters HashTable of values containing the parameters required to make the API call .EXAMPLE $AllAccountsJSON = Get-VPASAllAccounts .EXAMPLE $InputParameters = @{} $AllAccountsJSON = Get-VPASAllAccounts -InputParameters $InputParameters .OUTPUTS If successful: { "count": 176, "value": [ ... { "categoryModificationTime": 1715701023, "platformId": "VPASDualControl", "safeName": "VPASRequestSafe", "id": "120_3", "name": "Operating System-VPASDualControl-vman.com-DomainAdmin01", "address": "vman.com", "userName": "DomainAdmin011", "secretType": "password", "platformAccountProperties": "", "secretManagement": "@{automaticManagementEnabled=True; lastModifiedTime=1715222718}", "createdTime": 1715222718 }, { "categoryModificationTime": 1715227807, "platformId": "VPASDualControl", "safeName": "VPASRequestSafe", "id": "120_4", "name": "Operating System-VPASDualControl-vman.com-DomainAdmin02", "address": "vman.com", "userName": "DomainAdmin02", "secretType": "password", "platformAccountProperties": "", "secretManagement": "@{automaticManagementEnabled=True; lastModifiedTime=1715227806}", "createdTime": 1715227806 }, { "categoryModificationTime": 1715227821, "platformId": "VPASDualControl", "safeName": "VPASRequestSafe", "id": "120_5", "name": "Operating System-VPASDualControl-vman.com-DomainAdmin03", "address": "vman.com", "userName": "DomainAdmin03", "secretType": "password", "platformAccountProperties": "", "secretManagement": "@{automaticManagementEnabled=True; lastModifiedTime=1715227820}", "createdTime": 1715227820 }, ... ] } --- $false if failed #> function Get-VPASAllAccounts{ [OutputType('System.Object','System.Collections.Hashtable',[bool])] [CmdletBinding(DefaultParameterSetName='Set1')] Param( [Parameter(Mandatory=$true,ParameterSetName='InputParameters',ValueFromPipelineByPropertyName=$true,HelpMessage="Hashtable of parameters required to make API call, refer to get-help -examples for valid inputs")] [hashtable]$InputParameters, [Parameter(Mandatory=$false,ValueFromPipelineByPropertyName=$true)] [hashtable]$token ) Begin{ $tokenval,$sessionval,$PVWA,$Header,$ISPSS,$IdentityURL,$EnableTextRecorder,$AuditTimeStamp,$NoSSL,$VaultVersion,$HideWarnings,$AuthenticatedAs,$SubDomain,$EnableTroubleshooting = Get-VPASSession -token $token $CommandName = $MyInvocation.MyCommand.Name $log = Write-VPASTextRecorder -inputval $CommandName -token $token -LogType COMMAND } Process{ try{ if($PSCmdlet.ParameterSetName -eq "InputParameters"){ $KeyHash = @{ set1 = @{ AcceptableKeys = @() MandatoryKeys = @() } } $CheckSet = Test-VPASHashtableKeysHelper -InputHash $InputParameters -KeyHash $KeyHash if(!$CheckSet){ $log = Write-VPASTextRecorder -inputval "FAILED TO FIND TARGET PARAMETER SET" -token $token -LogType MISC Write-Verbose "FAILED TO FIND TARGET PARAMETER SET" Write-VPASOutput -str "FAILED TO FIND TARGET PARAMETER SET...VIEW EXAMPLES BELOW:" -type E $examples = Write-VPASExampleHelper -CommandName $CommandName return $false } else{ foreach($key in $InputParameters.Keys){ Set-Variable -Name $key -Value $InputParameters.$key } } } }catch{ $log = Write-VPASTextRecorder -inputval $_ -token $token -LogType ERROR $log = Write-VPASTextRecorder -inputval "REST API COMMAND RETURNED: FALSE" -token $token -LogType MISC Write-Verbose "FAILED TO RETRIEVE ACCOUNTS" Write-VPASOutput -str $_ -type E return $false } try{ Write-Verbose "BUILDING BLANK SEARCH QUERY" $searchQuery = " " Write-verbose "MAKING API CALL TO CYBERARK" if($NoSSL){ Write-Verbose "NO SSL ENABLED, USING HTTP INSTEAD OF HTTPS" $uri = "http://$PVWA/PasswordVault/api/Accounts?limit=1000&search=$searchQuery" } else{ Write-Verbose "SSL ENABLED BY DEFAULT, USING HTTPS" $uri = "https://$PVWA/PasswordVault/api/Accounts?limit=1000&search=$searchQuery" } $log = Write-VPASTextRecorder -inputval $uri -token $token -LogType URI $log = Write-VPASTextRecorder -inputval "GET" -token $token -LogType METHOD $output = @{ count = 0 value = "" } if($sessionval){ $response = Invoke-RestMethod -Headers @{"Authorization"=$Header} -Uri $uri -Method GET -ContentType "application/json" -WebSession $sessionval } else{ $response = Invoke-RestMethod -Headers @{"Authorization"=$Header} -Uri $uri -Method GET -ContentType "application/json" } $log = Write-VPASTextRecorder -inputval $response -token $token -LogType RETURNARRAY $output.count = $response.count $output.value = $response.value $nextlink = $response.nextLink while(![String]::IsNullOrEmpty($nextlink)){ if($NoSSL){ Write-Verbose "NO SSL ENABLED, USING HTTP INSTEAD OF HTTPS" $uri = "http://$PVWA/PasswordVault/$nextlink" } else{ Write-Verbose "SSL ENABLED BY DEFAULT, USING HTTPS" $uri = "https://$PVWA/PasswordVault/$nextlink" } $log = Write-VPASTextRecorder -inputval $uri -token $token -LogType URI $log = Write-VPASTextRecorder -inputval "GET" -token $token -LogType METHOD if($sessionval){ $response = Invoke-RestMethod -Headers @{"Authorization"=$Header} -Uri $uri -Method GET -ContentType "application/json" -WebSession $sessionval } else{ $response = Invoke-RestMethod -Headers @{"Authorization"=$Header} -Uri $uri -Method GET -ContentType "application/json" } $log = Write-VPASTextRecorder -inputval $response -token $token -LogType RETURN $output.count = $response.count $output.value += $response.value $nextlink = $response.nextLink } $result = $output Write-Verbose "PARSING DATA FROM CYBERARK" $counter = $result.count if($counter -gt 1){ Write-Verbose "RETURNING ALL ACCOUNTS" $outputlog = $response return $result } }catch{ $log = Write-VPASTextRecorder -inputval $_ -token $token -LogType ERROR $log = Write-VPASTextRecorder -inputval "REST API COMMAND RETURNED: FALSE" -token $token -LogType MISC Write-Verbose "COULD NOT GET ALL ACCOUNTS" Write-VPASOutput -str $_ -type E return $false } } End{ $log = Write-VPASTextRecorder -inputval $CommandName -token $token -LogType DIVIDER } } |