Get-VPASAccountGroupMembers


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

GET ACCOUNT GROUP MEMBERS


Description:

USE THIS FUNCTION TO GET ACCOUNT GROUP MEMBERS


Syntax:

Get-VPASAccountGroupMembers -GroupID <String> [-ExportToCSV] [-CSVDirectory <String>] [-token <Hashtable>] [<CommonParameters>]

Get-VPASAccountGroupMembers -safe <String> -GroupName <String> [-ExportToCSV] [-CSVDirectory <String>] [-token <Hashtable>] [<CommonParameters>]

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


Parameters:

-GroupID <String>
Unique ID that maps to the target AccountGroup
Supply GroupID to skip any querying for target AccountGroup

Required: true
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-safe <String>
Target unique safe name

Required: true
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-GroupName <String>
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

Required: true
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-ExportToCSV [<SwitchParameter>]
Output results to a CSV file found in AppData\Local\VPASModuleOutputs directory

Required: false
Position: named
Default value: False
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-CSVDirectory <String>
Output directory where the exported CSV file will be saved to
Default value: C:\Users\{CurrentUser}\AppData\Local\VPASModuleOutputs\ExportedCSVs

Required: false
Position: named
Default value:
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

-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

<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)


Examples:

$AccountGroupMembersJSON = Get-VPASAccountGroupMembers -GroupID {GROUPID VALUE}

$InputParameters = @{
        GroupID = "12_123"
         ExportToCSV = $true|$false
         CSVDirectory = "C:\Temp"
}
$AccountGroupMembersJSON = Get-VPASAccountGroupMembers -InputParameters $InputParameters

$InputParameters = @{
        safe = "TargetSafe"
        GroupName = "VpasGroupTest"
         ExportToCSV = $true|$false
         CSVDirectory = "C:\Temp"
}
$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