public/Get-VPASSafeMemberSearch.ps1
|
<#
.Synopsis GET SPECIFIC SAFE MEMBER IN A SAFE CREATED BY: Vadim Melamed, EMAIL: vpasmodule@gmail.com .DESCRIPTION USE THIS FUNCTION TO RETRIEVE A SPECIFIC SAFE MEMBER FROM A SPECIFIED SAFE .LINK https://vpasmodule.com/commands/Get-VPASSafeMemberSearch .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 safe Target unique safe name .PARAMETER member Target unique safe member .PARAMETER InputParameters HashTable of values containing the parameters required to make the API call .EXAMPLE $SafeMemberJSON = Get-VPASSafeMemberSearch -safe {SAFE VALUE} -member {MEMBER VALUE} .EXAMPLE $InputParameters = @{ safe = "TargetSafeName" member = "TargetSafeMember" } $SafeMemberJSON = Get-VPASSafeMemberSearch -InputParameters $InputParameters .OUTPUTS If successful: { "safeUrlId": "TestSafe", "safeName": "TestSafe", "safeNumber": 121, "memberId": "1dfc3edf-ksjdf-876243-jh675-lkjahdkj78687", "memberName": "vadim@vman.com", "memberType": "User", "membershipExpirationDate": null, "isExpiredMembershipEnable": false, "isPredefinedUser": false, "isReadOnly": true, "permissions": { "useAccounts": true, "retrieveAccounts": true, "listAccounts": true, "addAccounts": true, "updateAccountContent": true, "updateAccountProperties": true, "initiateCPMAccountManagementOperations": true, "specifyNextAccountContent": true, "renameAccounts": true, "deleteAccounts": true, "unlockAccounts": true, "manageSafe": true, "manageSafeMembers": true, "backupSafe": true, "viewAuditLog": true, "viewSafeMembers": true, "accessWithoutConfirmation": true, "createFolders": true, "deleteFolders": true, "moveAccountsAndFolders": true, "requestsAuthorizationLevel1": true, "requestsAuthorizationLevel2": false } } --- $false if failed #> function Get-VPASSafeMemberSearch{ [OutputType('System.Object',[bool])] [CmdletBinding(DefaultParameterSetName='Set1')] Param( [Parameter(Mandatory=$true,ParameterSetName='Set1',ValueFromPipelineByPropertyName=$true,HelpMessage="Enter SafeID to query (for example: TestSafe1)")] [String]$safe, [Parameter(Mandatory=$true,ParameterSetName='Set1',ValueFromPipelineByPropertyName=$true,HelpMessage="Enter target SafeMember to query on (for example: 'Vault Admins')")] [String]$member, [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 = @("safe","member") MandatoryKeys = @("safe","member") } } $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 SAFE MEMBERS" Write-VPASOutput -str $_ -type E return $false } try{ $outputreturn = @() Write-Verbose "MAKING API CALL TO CYBERARK" if($NoSSL){ Write-Verbose "NO SSL ENABLED, USING HTTP INSTEAD OF HTTPS" $uri = "http://$PVWA/PasswordVault/api/Safes/$safe/Members/$member/" } else{ Write-Verbose "SSL ENABLED BY DEFAULT, USING HTTPS" $uri = "https://$PVWA/PasswordVault/api/Safes/$safe/Members/$member/" } $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 Write-Verbose "RETRIEVED DATA FROM API CALL" Write-Verbose "RETURNING OUTPUT" 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 GET SAFE MEMBERS" Write-VPASOutput -str $_ -type E return $false } } End{ $log = Write-VPASTextRecorder -inputval $CommandName -token $token -LogType DIVIDER } } |