| external help file | TeamViewerPS-help.xml |
|---|---|
| Module Name | TeamViewerPS |
| online version | https://github.com/teamviewer/TeamViewerPS/blob/main/Docs/Help/Remove-TeamViewerRole.md |
| schema | 2.0.0 |
Deletes one specific role from the TeamViewer company.
Remove-TeamViewerRole [-ApiToken] <SecureString> [-RoleId] <Object> [-WhatIf] [-Confirm]
[<CommonParameters>]Deletes one specific role from the TeamViewer company. All permissions and user assignments of the role will be deleted too.
PS /> Remove-TeamViewerRole -RoleId '9b465ea2-2f75-4101-a057-58a81ed0e57b'Deletes the role with Id 9b465ea2-2f75-4101-a057-58a81ed0e57b.
PS /> Remove-TeamViewerRole -RoleId (Get-TeamViewerRole | Where-Object { ($_.RoleName -eq 'Test Role') } ).RoleIDDeletes a role with the role Id retrieved from Get-TeamViewerRole as input.
In this example, the role with the name Test Role.
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 role to be deleted.
Type: Object
Parameter Sets: (All)
Aliases: Id, Role
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.