Get-VPASAccountGroups


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

GET ACCOUNT GROUPS


Description:

USE THIS FUNCTION TO GET ACCOUNT GROUPS BY SAFE


Syntax:

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

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


Parameters:

-safe <String>
Target unique safe name

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:

$AccountGroupsJSON = Get-VPASAccountGroups -safe {SAFE VALUE}

$InputParameters = @{
        safe = "TargetSafe"
         ExportToCSV = $true|$false
         CSVDirectory = "C:\Temp"
}
$AccountGroupsJSON = Get-VPASAccountGroups -InputParameters $InputParameters


Outputs:

If successful:
[
         {
                 "GroupID": "35_16",
                 "GroupName": "GroupTestA",
                 "GroupPlatformID": "GroupMasterVpasModule",
                 "Safe": "VadimTestSafe"
         },
         {
                 "GroupID": "35_26",
                 "GroupName": "GroupTestB",
                 "GroupPlatformID": "GroupMasterVpasModule",
                 "Safe": "VadimTestSafe"
         }
]

$false if failed