Skip to content

Remove-TeamViewerUserTFA.md

Latest commit

 

History

History
129 lines (89 loc) · 2.45 KB

Remove-TeamViewerUserTFA.md

File metadata and controls

129 lines (89 loc) · 2.45 KB
Raw

external help file: TeamViewerPS-help.xml Module Name: TeamViewerPS online version: https://github.com/teamviewer/TeamViewerPS/blob/main/Docs/Help/Remove-TeamViewerUser.md schema: 2.0.0

Remove-TeamViewerUserTFA

SYNOPSIS

Removes a users two-factor authentication (TFA) from the TeamViewer account.

SYNTAX

Remove-TeamViewerUser [-APIToken] <SecureString> [-User] <Object> [-Permanent] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

Removes a users two-factor authentication (TFA) from the TeamViewer account.

EXAMPLES

Example 1

PS C:\> Remove-TeamViewerUserTFA -User 'u1234'

Example 2

Get-TeamViewerUser -Email 'user@example.test' | Remove-TeamViewerUserTFA

Disables two-factor authentication for the user retrieved via the pipeline.

Example 3

Remove-TeamViewerUserTFA -Id 'u1234567'

Uses the Id alias to disable two-factor authentication for the given user.

PARAMETERS

-APIToken

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: False

-User

Object 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: False

-Confirm

Prompts 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: False

-WhatIf

Shows 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: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

System.Object

OUTPUTS

NOTES

RELATED LINKS