Get-TeamViewerUserByRole.md

---

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

Get-TeamViewerUserByRole

SYNOPSIS

Lists users assigned to one specific role.

SYNTAX

Get-TeamViewerUserByRole [-APIToken] <SecureString> [-Role] <Object> [<CommonParameters>]

DESCRIPTION

Lists all users of role in the TeamViewer company associated with the API access token.

EXAMPLES

Example 1

Get-TeamViewerUserByRole -Role '72abbedc-9853-4fc8-9d28-fa35e207b048'

Lists all users of the role 72abbedc-9853-4fc8-9d28-fa35e207b048.

Example 2

Get-TeamViewerUserByRole -RoleId 'c0cb303a-8a85-4e54-b657-a4757c791aef'

Lists all users of the given role using the RoleId alias.

Example 3

(Get-TeamViewerUserByRole -RoleId '72abbedc-9853-4fc8-9d28-fa35e207b048').Count

Returns the number of users assigned to the given role.

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

-Role

Role to list its assigned users.

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

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

None

OUTPUTS

TeamViewerPS.RoleUserMembership

An array of TeamViewerPS.RoleUserMembership objects with a UserId property.

NOTES

RELATED LINKS