public/Get-VPASEPVUserDetailsSearch.ps1
|
<#
.Synopsis GET EPV USER DETAILS VIA SEARCH QUERY CREATED BY: Vadim Melamed, EMAIL: vpasmodule@gmail.com .DESCRIPTION USE THIS FUNCTION TO GET EPV USER(s) DETAILS THROUGH A SEARCH QUERY .LINK https://vpasmodule.com/commands/Get-VPASEPVUserDetailsSearch .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 SearchQuery Search string to find target resource via username, address, safe, platform, etc. Comma separated for multiple fields, or to search all pass a blank value like so: " " .PARAMETER InputParameters HashTable of values containing the parameters required to make the API call .EXAMPLE $EPVUserDetailsJSON = Get-VPASEPVUserDetailsSearch -SearchQuery {SEARCHQUERY VALUE} .EXAMPLE $InputParameters = @{ SearchQuery = "VmanEPVUser" } $EPVUserDetailsJSON = Get-VPASEPVUserDetailsSearch -InputParameters $InputParameters .OUTPUTS If successful: { "Users": [ ... { "id": 41, "username": "vadim@vman.com", "source": "CyberArk", "userType": "EPVUser", "componentUser": false, "groupsMembership": " ", "vaultAuthorization": "AddUpdateUsers AddSafes ManageServerFileCategories AuditUsers ResetUsersPasswords ActivateUsers", "location": "\\", "personalDetails": "@{firstName=Vadim; middleName=; lastName=Melamed; organization=; department=}", "enableUser": true, "suspended": false }, { "id": 56, "username": "VadimAdmin@vman.com", "source": "CyberArk", "userType": "EPVUser", "componentUser": false, "groupsMembership": " ", "vaultAuthorization": "AddUpdateUsers AddSafes ManageServerFileCategories AuditUsers ResetUsersPasswords ActivateUsers", "location": "\\", "personalDetails": "@{firstName=VadimAdmin; middleName=; lastName=; organization=; department=}", "enableUser": true, "suspended": false }, { "id": 188, "username": "VpasModuleAppIDTest", "source": "CyberArk", "userType": "AIMAccount", "componentUser": true, "groupsMembership": "", "vaultAuthorization": "", "location": "\\", "personalDetails": "@{firstName=vadim; middleName=; lastName=melamed; organization=; department=}", "enableUser": true, "suspended": false }, ... ], "Total": 6 } --- $false if failed #> function Get-VPASEPVUserDetailsSearch{ [OutputType('System.Object',[bool])] [CmdletBinding(DefaultParameterSetName='Set1')] Param( [Parameter(Mandatory=$true,ParameterSetName='Set1',ValueFromPipelineByPropertyName=$true,HelpMessage="Enter wildcard search to query for target EPVUsers")] [String]$SearchQuery, [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 = @("SearchQuery") MandatoryKeys = @("SearchQuery") } } $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 EPV USER DETAILS" Write-VPASOutput -str $_ -type E return $false } try{ if($NoSSL){ Write-Verbose "NO SSL ENABLED, USING HTTP INSTEAD OF HTTPS" $uri = "http://$PVWA/PasswordVault/API/Users?ExtendedDetails=True&search=$SearchQuery" } else{ Write-Verbose "SSL ENABLED BY DEFAULT, USING HTTPS" $uri = "https://$PVWA/PasswordVault/api/Users?ExtendedDetails=True&search=$SearchQuery" } $log = Write-VPASTextRecorder -inputval $uri -token $token -LogType URI $log = Write-VPASTextRecorder -inputval "GET" -token $token -LogType METHOD Write-Verbose "MAKING API CALL TO CYBERARK" 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" } $outputlog = $response $log = Write-VPASTextRecorder -inputval $outputlog -token $token -LogType RETURNARRAY Write-Verbose "SUCCESSFULLY RETRIEVED DETAILS FOR $SearchQuery" Write-Verbose "RETURNING JSON OBJECT" return $response }catch{ $log = Write-VPASTextRecorder -inputval $_ -token $token -LogType ERROR $log = Write-VPASTextRecorder -inputval "REST API COMMAND RETURNED: FALSE" -token $token -LogType MISC Write-Verbose "UNABLE TO RETRIEVE DETAILS FOR $SearchQuery" Write-VPASOutput -str $_ -type E return $false } } End{ $log = Write-VPASTextRecorder -inputval $CommandName -token $token -LogType DIVIDER } } |