Skip to content

New-TeamViewerUser.md

Latest commit

 

History

History
382 lines (280 loc) · 7.29 KB

New-TeamViewerUser.md

File metadata and controls

382 lines (280 loc) · 7.29 KB
external help file TeamViewerPS-help.xml
Module Name TeamViewerPS
online version https://github.com/teamviewer/TeamViewerPS/blob/main/Docs/Help/New-TeamViewerUser.md
schema 2.0.0

New-TeamViewerUser

SYNOPSIS

Create a new TeamViewer company user.

SYNTAX

WithPassword (Default)

New-TeamViewerUser -ApiToken <SecureString> -Email <String> -Name <String> -Password <SecureString> [-RoleId <String>][-IgnorePredefinedRole <switch>]
 [-SsoCustomerIdentifier <SecureString>][-Culture <CultureInfo>] [-LogSessions <Boolean>] [-ShowCommentWindow <Boolean>] [-SubscribeNewsletter <Boolean>] [-TFAEnforcement <Boolean>] [-CustomQuickSupportId <String>] [-CustomQuickJoinId <String>] [-LicenseKey <String>] [-MeetingLicenseKey <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

WithoutPassword

New-TeamViewerUser -ApiToken <SecureString> -Email <String> -Name <String> [-WithoutPassword][-IgnorePredefinedRole <switch>]
 [-SsoCustomerIdentifier <SecureString>][-Culture <CultureInfo>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Creates a new user for the company that is associated to the API access token.

EXAMPLES

Example 1

PS /> New-TeamViewerUser -Email 'test@example.test' -Name 'Test User'

Create a new user with the given email address and name. The password will be prompted.

Example 2

PS /> New-TeamViewerUser -Email 'test@example.test' -Name 'Test User' -WithoutPassword

Create a new user with the given email address and name. It will be created without a password. The user must reset the password through the TeamViewer web page.

Example 3

PS /> New-TeamViewerUser -Email 'test@example.test' -Name 'Test User' -RoleId '9b465ea2-2f75-4101-a057-58a81ed0e57b'

Create a new user with the given email address and name. The Role with RoleID 9b465ea2-2f75-4101-a057-58a81ed0e57b will be assigned.

PARAMETERS

-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

-Culture

Culture used for the welcome email of the new user.

Type: CultureInfo
Parameter Sets: (All)
Aliases:

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

-Email

Email address of the new user.

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

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

-Name

Display name of the new user.

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

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

-Password

Password of the new user as secure string.

Type: SecureString
Parameter Sets: WithPassword
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 created with SSO activation step already done. With this option, the new user must not enter the TeamViewer password at all when doing Single Sign-On.

Type: SecureString
Parameter Sets: (All)
Aliases:

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

-RoleId

Role assigned to the user.

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

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

-IgnorePredefinedRole

Ignore Predefined Role from being assigned.

Type: switch
Parameter Sets: (All)
Aliases: None

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

-SubscribeNewsletter

Enables ($true) or disables ($false) the newsletter.

Type: Boolean
Parameter Sets: ByParameters
Aliases:

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

-ShowCommentWindow

Displays ($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

Enables ($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

Defines 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

MeetingLicenseKey

Specifies the meeting 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

-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

-WithoutPassword

If given, the new user is created without a password. The user must request to reset the password on the TeamViewer web page.

Type: SwitchParameter
Parameter Sets: WithoutPassword
Aliases: NoPassword

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