public/Get-VPASAccountGroupMembers.ps1
|
<#
.Synopsis GET ACCOUNT GROUP MEMBERS CREATED BY: Vadim Melamed, EMAIL: vpasmodule@gmail.com .DESCRIPTION USE THIS FUNCTION TO GET ACCOUNT GROUP MEMBERS .LINK https://vpasmodule.com/commands/Get-VPASAccountGroupMembers .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 GroupName Unique target GroupName that will be used to query for the GroupID if no GroupID is passed An account group is set of accounts that will have the same password synced across the entire group .PARAMETER GroupID Unique ID that maps to the target AccountGroup Supply GroupID to skip any querying for target AccountGroup .PARAMETER InputParameters HashTable of values containing the parameters required to make the API call .EXAMPLE $AccountGroupMembersJSON = Get-VPASAccountGroupMembers -GroupID {GROUPID VALUE} .EXAMPLE $InputParameters = @{ GroupID = "12_123" } $AccountGroupMembersJSON = Get-VPASAccountGroupMembers -InputParameters $InputParameters .EXAMPLE $InputParameters = @{ safe = "TargetSafe" GroupName = "VpasGroupTest" } $AccountGroupMembersJSON = Get-VPASAccountGroupMembers -InputParameters $InputParameters .OUTPUTS If successful: [ { "AccountID": "35_33", "SafeName": "VadimTestSafe", "PlatformID": "VadimWindowsDomain", "Address": "vman.com", "UserName": "GroupMemberA" }, { "AccountID": "35_34", "SafeName": "VadimTestSafe", "PlatformID": "WinDomain", "Address": "vman.com", "UserName": "GroupMemberB" } ] --- $false if failed #> function Get-VPASAccountGroupMembers{ [OutputType('System.Object',[bool])] [CmdletBinding(DefaultParameterSetName='Set1')] Param( [Parameter(Mandatory=$true,ParameterSetName='Set1',ValueFromPipelineByPropertyName=$true,HelpMessage="Unique GroupID of the target account group (for example: 22_123)")] [String]$GroupID, [Parameter(Mandatory=$true,ParameterSetName='Set2',ValueFromPipelineByPropertyName=$true,HelpMessage="Safename of the target account group (for example: VpasTestSafe01)")] [String]$safe, [Parameter(Mandatory=$true,ParameterSetName='Set2',ValueFromPipelineByPropertyName=$true,HelpMessage="Name of the target account group (for example: VpasGroupTest)")] [String]$GroupName, [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 = @("GroupID") MandatoryKeys = @("GroupID") } set2 = @{ AcceptableKeys = @("safe","GroupName") MandatoryKeys = @("safe","GroupName") } } $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 ACCOUNT GROUP" Write-VPASOutput -str $_ -type E return $false } try{ if([String]::IsNullOrEmpty($GroupID)){ write-verbose "NO GROUPID PASSED, INVOKING GROUPID HELPER" if([String]::IsNullOrEmpty($safe) -or [String]::IsNullOrEmpty($GroupName)){ write-verbose "IF NO GROUPID IS PASSED, SAFE AND GROUPNAME MUST BE PASSED...RETURNING FALSE" Write-VPASOutput -str "IF NO GROUPID IS PASSED, SAFE AND GROUPNAME MUST BE PASSED" -type E } else{ $GroupID = Get-VPASAccountGroupIDHelper -token $token -safe $safe -GroupName $GroupName } } else{ Write-Verbose "GROUPID SUPPLIED...SKIPPING GROUPID HELPER" } if(!$GroupID){ $log = Write-VPASTextRecorder -inputval "COULD NOT FIND UNIQUE GROUPID" -token $token -LogType MISC $log = Write-VPASTextRecorder -inputval "REST API COMMAND RETURNED: FALSE" -token $token -LogType MISC write-verbose "COULD NOT FIND UNIQUE GROUPID...RETURNING FALSE" Write-VPASOutput -str "COULD NOT FIND UNIQUE GROUPID...RETURNING FALSE" -type E return $false } if($NoSSL){ Write-Verbose "NO SSL ENABLED, USING HTTP INSTEAD OF HTTPS" $uri = "http://$PVWA/PasswordVault/API/AccountGroups/$GroupID/Members" } else{ Write-Verbose "SSL ENABLED BY DEFAULT, USING HTTPS" $uri = "https://$PVWA/PasswordVault/API/AccountGroups/$GroupID/Members" } $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" } foreach($rec in $response){ $log = Write-VPASTextRecorder -inputval $rec -token $token -LogType RETURN } 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 GET ACCOUNT GROUP MEMBERS FOR GROUPID: $GroupID" Write-VPASOutput -str $_ -type E return $false } } End{ $log = Write-VPASTextRecorder -inputval $CommandName -token $token -LogType DIVIDER } } |