| external help file | Module Name | online version | schema |
|---|---|---|---|
TeamViewerPS-help.xml |
TeamViewerPS |
2.0.0 |
Assign a list of accountIds to a role.
Add-TeamViewerUserToRole [-ApiToken] <SecureString> [-RoleId] <Object> [-Account] <string[]> [-WhatIf]
[-Confirm] [<CommonParameters>]Assigns one or many users to a role. A role should belong to the TeamViewer company associated with the API access token.
PS /> Add-TeamViewerUserToRole -RoleId '9b465ea2-2f75-4101-a057-58a81ed0e57b' -Account @('123', '456', '789')Assigns role with id 9b465ea2-2f75-4101-a057-58a81ed0e57b to users with id 123, 456, 789.
PS /> @('123', '456', '789') | Add-TeamViewerUserToRole -Role '9b465ea2-2f75-4101-a057-58a81ed0e57b'Assigns role with id 9b465ea2-2f75-4101-a057-58a81ed0e57b to users with id 123, 456, 789.
Ids are passed as pipeline input.
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 which users will be assigned to.
Type: Object
Parameter Sets: (All)
Aliases: Role
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseUsers to be assigned to a user role.
Type: string[]
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
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.