DELETE ACCOUNT FROM ACCOUNT GROUP

USE THIS FUNCTION TO DELETE ACCOUNT FROM ACCOUNT GROUP

Remove-VPASAccountFromAccountGroup -GroupID <String> [-safe <String>] [-platform <String>] [-username <String>] [-address <String>] [-WhatIf] [-HideWhatIfOutput] [-token <Hashtable>] [<CommonParameters>]

Remove-VPASAccountFromAccountGroup -GroupID <String> -AcctID <String> [-WhatIf] [-HideWhatIfOutput] [-token <Hashtable>] [<CommonParameters>]

Remove-VPASAccountFromAccountGroup [-safe <String>] [-platform <String>] [-username <String>] [-address <String>] -GroupName <String> [-WhatIf] [-HideWhatIfOutput] [-token <Hashtable>] [<CommonParameters>]

Remove-VPASAccountFromAccountGroup -AcctID <String> -GroupName <String> [-WhatIf] [-HideWhatIfOutput] [-token <Hashtable>] [<CommonParameters>]

Remove-VPASAccountFromAccountGroup -InputParameters <Hashtable> [-token <Hashtable>] [<CommonParameters>]

-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>
Safe name that will be used to query for the target account if no AcctID is passed

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

-platform <String>
PlatformID that will be used to query for the target account if no AcctID is passed

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

-username <String>
Username that will be used to query for the target account if no AcctID is passed

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

-address <String>
Address that will be used to query for the target account if no AcctID is passed

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

-AcctID <String>
Unique ID that maps to a single account, passing this variable will skip any query functions

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

-WhatIf [<SwitchParameter>]
Run code simulation to see what is affected by running the command as well as any possible implications
This is a code simulation flag, meaning the command will NOT actually run

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

-HideWhatIfOutput [<SwitchParameter>]
Suppress any code simulation output from the console

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

$WhatIfSimulation = Remove-VPASAccountFromAccountGroup -GroupID {GROUPID VALUE} -AcctID {ACCTID VALUE} -WhatIf

$DeleteAccountFromAccountGroupStatus = Remove-VPASAccountFromAccountGroup -GroupID {GROUPID VALUE} -AcctID {ACCTID VALUE}

$DeleteAccountFromAccountGroupStatus = Remove-VPASAccountFromAccountGroup -GroupName {GROUPNAME VALUE} -safe {SAFE VALUE} -platform {PLATFORM VALUE} -username {USERNAME VALUE} -address {ADDRESS VALUE}

$InputParameters = @{
        GroupID = "22_12"
         safe = "TargetSafeName"
         platform = "TargetPlatformID"
         username = "TargetUsername"
         address = "targetAddress"
         WhatIf = $true|$false
         HideWhatIfOutput = $true|$false
}
$DeleteAccountFromAccountGroupStatus = Remove-VPASAccountFromAccountGroup -InputParameters $InputParameters

$InputParameters = @{
        GroupID = "22_12"
         AcctID = "22_123"
         WhatIf = $true|$false
         HideWhatIfOutput = $true|$false
}
$DeleteAccountFromAccountGroupStatus = Remove-VPASAccountFromAccountGroup -InputParameters $InputParameters

$InputParameters = @{
        safe = "TargetSafeName"
         platform = "TargetPlatformID"
         username = "TargetUsername"
         address = "targetAddress"
         GroupName = "TargetAccountGroupName"
         WhatIf = $true|$false
         HideWhatIfOutput = $true|$false
}
$DeleteAccountFromAccountGroupStatus = Remove-VPASAccountFromAccountGroup -InputParameters $InputParameters

$InputParameters = @{
        AcctID = "22_123"
         GroupName = "TargetAccountGroupName"
         WhatIf = $true|$false
         HideWhatIfOutput = $true|$false
}
$DeleteAccountFromAccountGroupStatus = Remove-VPASAccountFromAccountGroup -InputParameters $InputParameters

$true if successful

$false if failed