Skip to content

Set-TeamViewerUser.md

Latest commit

 

History

History
385 lines (279 loc) · 7.43 KB

Set-TeamViewerUser.md

File metadata and controls

385 lines (279 loc) · 7.43 KB
external help file TeamViewerPS-help.xml
Module Name TeamViewerPS
online version https://github.com/teamviewer/TeamViewerPS/blob/main/Docs/Help/Set-TeamViewerUser.md
schema 2.0.0

Set-TeamViewerUser

SYNOPSIS

Change properties of a TeamViewer company user.

SYNTAX

ByParameters (Default)

Set-TeamViewerUser -ApiToken <SecureString> -User <Object> [-Active <Boolean>] [-Email <String>] [-AssignRoleId <String[]>][-UnassignRoleId <String[]>]
 [-Name <String>] [-Password <SecureString>] [-SsoCustomerIdentifier <SecureString>] [-LogSessions <Boolean>] [-ShowCommentWindow <Boolean>] [-TFAEnforcement <Boolean>] [-CustomQuickSupportId <String>] [-CustomQuickJoinId <String>] [-LicenseKey <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

ByProperties

Set-TeamViewerUser -ApiToken <SecureString> -User <Object> -Property <Hashtable> [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Changes information for a selected user.

EXAMPLES

Example 1

PS /> Set-TeamViewerUser -User 'u1234' -Name 'New user name'

Change the name of a user.

Example 2

PS /> Set-TeamViewerUser -User 'u1234' -Password (Read-Host -AsSecureString) -Email 'test@example.test'

Change email address and password of a user.

Example 3

PS /> $props = @{active = $false}
PS /> Set-TeamViewerUser -User 'u1234' -Property $props

Deactivate a user using a properties hashtable.

Example 4

PS /> $ssoCustomerIdentifier = ("abc" | ConvertTo-SecureString -AsPlainText -Force)
PS /> Set-TeamViewerUser -UserId 'u1234' -SsoCustomerIdentifier $ssoCustomerIdentifier

Do the SSO activation step for the given user. This can also be used to repair a possibly broken SSO login token for that user.

Example 5

PS /> Set-TeamViewerUser -User 'u1234' -Name 'New user name' -AssignRoleId 'dd1cb784-bd1e-4056-a60b-3764ffe69e35' 
-UnassignRoleId 'a6776890-d687-4c70-b180-9b563f15d1ab'

Assign and unassign Roles of the user u1234

PARAMETERS

-Active

Activates ($true) or deactivates ($false) the company user.

Type: Boolean
Parameter Sets: ByParameters
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ApiToken

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

-Confirm

Prompts you for confirmation before running the cmdlet.

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

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Email

Updated email address of the user.

Type: String
Parameter Sets: ByParameters
Aliases: EmailAddress

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Name

Updated name of the user.

Type: String
Parameter Sets: ByParameters
Aliases: DisplayName

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Password

New password of the user (as secure string).

Type: SecureString
Parameter Sets: ByParameters
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AssignRoleId

Role assigned to the user.

Type: String
Parameter Sets: (All)
Aliases: AssignRole

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-UnassignRoleId

Role unassigned from the user.

Type: String
Parameter Sets: (All)
Aliases: UnassignRole

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Property

Change policy information using a hashtable object. Valid hashtable keys are: active, email, name, password, sso_customer_id, permissions, tfa_enforcement , license_key, custom_quickjoin_id, custom_quicksupport_id, show_comment_window,log_sessions , AssignUserRoleIds, UnassignUserRoleIds

Type: Hashtable
Parameter Sets: ByProperties
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SsoCustomerIdentifier

Optional TeamViewer SSO customer identifier. If given, the user will be updated with SSO activation step already done. With this option, the user must not enter the TeamViewer password at when doing Single Sign-On.

Type: SecureString
Parameter Sets: ByParameters
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-LogSessions

Enables ($true) or disables ($false) session logging.

Type: Boolean
Parameter Sets: ByParameters
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ShowCommentWindow

Shows ($true) or hides ($false) the comment field.

Type: Boolean
Parameter Sets: ByParameters
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

TFAEnforcement

Activates ($true) or disables ($false) the enforcement of the two-factor authentication (TFA) for the user.

Type: Boolean
Parameter Sets: ByParameters
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CustomQuickSupportId

Specifies the ID of a custom QuickSupport module assigned to the user.

Type: String
Parameter Sets: ByParameters
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CustomQuickJoinId

Specifies the ID of a custom QuickJoin module assigned to the user.

Type: String
Parameter Sets: ByParameters
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

LicenseKey

Specifies the license key assigned to the user.

Type: String
Parameter Sets: ByParameters
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-User

Object that can be used to identify the user. This can either be the user ID or a user object that has been received using other module functions.

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

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

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

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

NOTES

RELATED LINKS