| external help file | Module Name | online version | schema |
|---|---|---|---|
TeamViewerPS-help.xml |
TeamViewerPS |
2.0.0 |
Retrieve users of a TeamViewer company.
Get-TeamViewerUser -ApiToken <SecureString> [-Name <String>] [-Email <String[]>] [-Permissions <String[]>]
[-PropertiesToLoad <Object>] [<CommonParameters>]Get-TeamViewerUser -ApiToken <SecureString> [-Id <String>] [-PropertiesToLoad <Object>] [<CommonParameters>]Lists all users of the TeamViewer company associated with the API access token. The list can optionally be filtered using additional parameters.
PS /> Get-TeamViewerUserList all users.
PS /> Get-TeamViewerUser -Id 'u1234'Retrieve a single user entry with the given ID.
PS /> Get-TeamViewerUser -Name 'Test' -PropertiesToLoad 'All'List all users of the company that have the string Test in their name.
The resulting list entries should contain all available user properties.
The TeamViewer API access token.
Type: SecureString
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseOptional list of email addresses. Can be used to only return users that exactly match one of the given email addresses.
Type: String[]
Parameter Sets: FilteredList
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseUser ID to return only a single user entry with that ID.
Type: String
Parameter Sets: ByUserId
Aliases: UserId
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseOptional name filter parameter that can be used to only list users that have the given string in their name.
Type: String
Parameter Sets: FilteredList
Aliases: PartialName
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseOptional permissions filter that can be used to only list users that have certain permissions. Multiple values can be given.
Type: String[]
Parameter Sets: FilteredList
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseCan be used to retrieve all available properties of a user or just a stripped-down minimal set of user properties.
Type: Object
Parameter Sets: (All)
Aliases:
Accepted values: All, Minimal
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.