Skip to content

Get-TeamViewerRole.md

Latest commit

 

History

History
93 lines (60 loc) · 1.66 KB

Get-TeamViewerRole.md

File metadata and controls

93 lines (60 loc) · 1.66 KB
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 and their permissions in a TeamViewer company.

SYNTAX

Get-TeamViewerRole [-ApiToken] <SecureString> [-Permissions] [<CommonParameters>]

DESCRIPTION

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

EXAMPLES

Example 1

PS /> Get-TeamViewerRole

Lists all roles and their permissions.

Example 2

PS /> Get-TeamViewerRole -ApiToken $token -Permissions

Lists all the possible permissions.

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

-Permissions

Return the list of currently supported permissions.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: ListPermissions

Required: False
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

System.Object

An array of TeamViewerPS.Role objects.

NOTES

RELATED LINKS