Get-TeamViewerRole.md

---

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

Get-TeamViewerRole

SYNOPSIS

Lists all roles in a TeamViewer company.

SYNTAX

Get-TeamViewerRole [-APIToken] <SecureString> [<CommonParameters>]

DESCRIPTION

Lists all roles in the TeamViewer company associated with the API access token.

EXAMPLES

Example 1

Get-TeamViewerRole

Lists all roles.

Example 2

Get-TeamViewerRole | Where-Object { $_.Name -eq 'Administrator' }

Lists only the role named 'Administrator'.

Example 3

Get-TeamViewerRole | Select-Object -Property Name, Id

Lists all roles showing only their name and 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

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.Role

An array of TeamViewerPS.Role objects.

NOTES

RELATED LINKS