| external help file | Module Name | online version | schema |
|---|---|---|---|
TeamViewerPS-help.xml |
TeamViewerPS |
2.0.0 |
Update properties of a user role.
Set-TeamViewerRole [-ApiToken] <SecureString> [-Name] <String> [-RoleId] <Object> [-Permissions] <Array> [-WhatIf] [-Confirm] [<CommonParameters>]Update properties of a user role. It allows to rename and alter permissions.
PS /> Set-TeamViewerRole -Name 'New name of role' -Permissions 'AllowGroupSharing','ModifyConnections' -RoleId '9b465ea2-2f75-4101-a057-58a81ed0e57b'Renames the role with id 9b465ea2-2f75-4101-a057-58a81ed0e57b to New name of role and enables the permissions AllowGroupSharing and ModifyConnections.
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: FalseThe new name of the User role.
Type: String
Parameter Sets: (All)
Aliases: RoleName
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe role to be updated.
Type: Object
Parameter Sets: (All)
Aliases: Role
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseUpdated set of permissions of the user role. Please see the TeamViewer API documentation for a list of valid values.
Type: Array
Parameter Sets: ByParameters
Aliases:
Required: False
Position: Named
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.