| external help file | Module Name | online version | schema |
|---|---|---|---|
TeamViewerPS-help.xml |
TeamViewerPS |
2.0.0 |
Removes a user from the TeamViewer tenant
Remove-TeamViewerUser [-ApiToken] <SecureString> [-User] <Object> [-Permanent] [-WhatIf] [-Confirm]
[<CommonParameters>]
Removes an existing user from the TeamViewer tenant. If the switch -Permanent is added the user is delete from TeamViewer completely, otherwise it is only removed from the tenant.
PS C:\> Remove-TeamViewerUser -User 'u1234'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: FalseDeletes the user account completely instead of just removing it from the tenant.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseObject that can be used to identify the user. This can either be the user ID or a user object that has been received using other module functions
Type: Object
Parameter Sets: (All)
Aliases: Id, UserId
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
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.