Set-TeamViewerDefaultRole.md

---

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

Set-TeamViewerDefaultRole

SYNOPSIS

Sets an existing role as default role.

SYNTAX

Set-TeamViewerDefaultRole [-APIToken] <SecureString> [-RoleId] <Object> [<CommonParameters>]

DESCRIPTION

Sets an existing role as default role. Every new user will get the default role assigned automatically during creation.

EXAMPLES

Example 1

Set-TeamViewerDefaultRole -RoleId '9b465ea2-2f75-4101-a057-58a81ed0e57b'

Sets the role with the id 9b465ea2-2f75-4101-a057-58a81ed0e57b as default role.

Example 2

Get-TeamViewerRole | where-Object { ($_.RoleName -eq 'Test Role') } | Set-TeamViewerDefaultRole

Sets the role with name Test Role as default role.

Example 3

Set-TeamViewerDefaultRole -Role 'c0cb303a-8a85-4e54-b657-a4757c791aef' -WhatIf

Uses the Role alias and shows what would happen when setting the role with the id c0cb303a-8a85-4e54-b657-a4757c791aef as default 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

-RoleId

The role to be set as Default Role.

Type: Object
Parameter Sets: (All)
Aliases: Id, Role

Required: True
Position: 1
Default value: None
Accept pipeline input: True
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

None

OUTPUTS

NOTES

RELATED LINKS