external help file: TeamViewerPS-help.xml Module Name: TeamViewerPS online version: https://github.com/teamviewer/TeamViewerPS/blob/main/Docs/Help/Remove-TeamViewerUserFromRole.md schema: 2.0.0
Un-assigns one or many users from a role.
Remove-TeamViewerUserFromRole [-APIToken] <SecureString> [-Role] <Object> [-User] <string[]> [-WhatIf] [-Confirm] [<CommonParameters>]Un-assigns one or many users from a role. A role belongs to the TeamViewer company associated with the API access token.
Remove-TeamViewerUserFromRole -Role '9b465ea2-2f75-4101-a057-58a81ed0e57b' -User @('123', '456', '789')Un-assigns users with id 123, 456, 789 from the role with id 9b465ea2-2f75-4101-a057-58a81ed0e57b.
@('123', '456', '789') | Remove-TeamViewerUserFromRole -Role '9b465ea2-2f75-4101-a057-58a81ed0e57b'Un-assigns users with id 123, 456, 789 from role with id 9b465ea2-2f75-4101-a057-58a81ed0e57b.
Ids are passed as pipeline input.
Remove-TeamViewerUserFromRole -Role '9b465ea2-2f75-4101-a057-58a81ed0e57b' -User 'u123'Un-assigns a single user identified by the u-prefixed account Id from the role.
The TeamViewer API access token.
Type: SecureString
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
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 where users will be unassigned from.
Type: Object
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseUsers to remove from a user role.
Type: Object[]
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
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.
An array of account Ids.