external help file: TeamViewerPS-help.xml Module Name: TeamViewerPS online version: https://github.com/teamviewer/TeamViewerPS/blob/main/Docs/Help/Remove-TeamViewerUserGroup.md schema: 2.0.0
Delete a user group from the TeamViewer company.
Remove-TeamViewerUserGroup [-APIToken] <SecureString> [-UserGroup] <Object> [-WhatIf] [-Confirm]
[<CommonParameters>]Deletes a use groups from the TeamViewer company. All information regarding the user group will be deleted too.
Remove-TeamViewerUserGroup -Id 1001Deletes the user group with Id 1001.
Remove-TeamViewerUserGroup -UserGroup (Get-TeamViewerUserGroup | Where-Object { $_.Name -eq "Test Group" })Remove a user group object retrieved using Get-TeamViewerUserGroup as input.
In this example, the user group with the name Test Group.
Remove-TeamViewerUserGroup -UserGroupId 1001Deletes the user group with Id 1001, using the UserGroupId alias.
The TeamViewer API access token.
Type: SecureString
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalsePrompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe user groups to be deleted.
Type: Object
Parameter Sets: (All)
Aliases: Id, UserGroupId
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseShows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.