Add-TeamViewerUserToRole.md

---

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

Add-TeamViewerUserToRole

SYNOPSIS

Assign a list of accountIds to a role.

SYNTAX

Add-TeamViewerUserToRole [-APIToken] <SecureString> [-Role] <Object> [-User] <string[]> [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Assigns one or many users to a role. A role should belong to the TeamViewer company associated with the API access token.

EXAMPLES

Example 1

Add-TeamViewerUserToRole -Role '9b465ea2-2f75-4101-a057-58a81ed0e57b' -User @('123', '456', '789')

Assigns role with id 9b465ea2-2f75-4101-a057-58a81ed0e57b to users with id 123, 456, 789.

Example 2

@('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.

Example 3

Add-TeamViewerUserToRole -Role '9b465ea2-2f75-4101-a057-58a81ed0e57b' -User 'u123'

Assigns the role with id 9b465ea2-2f75-4101-a057-58a81ed0e57b to a single user identified by the u-prefixed account Id.

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

-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

-Role

the role to which users will be assigned to.

Type: Object
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-User

Users to add as members of a user role.

Type: string[]
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByValue)
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.string[]

An array of account Ids.

OUTPUTS

NOTES

RELATED LINKS