Add-TeamViewerUserGroupToRole.md

---

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

Add-TeamViewerUserGroupToRole

SYNOPSIS

Assign a user group to a role.

SYNTAX

Add-TeamViewerUserGroupToRole [-APIToken] <SecureString> [-Role] <Object> [-UserGroup] <Object> [-WhatIf]
 [-Confirm] [<CommonParameters>]

DESCRIPTION

Assigns a user group to a role of the TeamViewer company associated with the API access token.

EXAMPLES

Example 1

Add-TeamViewerUserGroupToRole -Role  '9b465ea2-2f75-4101-a057-58a81ed0e57b' -UserGroup 1001

The given user group 1001 gets assigned to the role with Id 9b465ea2-2f75-4101-a057-58a81ed0e57b.

Example 2

Add-TeamViewerUserGroupToRole -Role 'c0cb303a-8a85-4e54-b657-a4757c791aef' -UserGroup 1001 -WhatIf

Shows what would happen when assigning the user group 1001 to the given role, without applying the change.

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 be assigned to the accountIds

Type: Object
Parameter Sets: (All)
Aliases:

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

-UserGroup

The user group to which the role should be assigned.

Type: Object
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
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

OUTPUTS

NOTES

RELATED LINKS