external help file | Module Name | online version | schema |
---|---|---|---|
TeamViewerPS-help.xml |
TeamViewerPS |
2.0.0 |
Add emails to the exclusion list of a TeamViewer Single Sign-On domain.
Add-TeamViewerSsoExclusion [-ApiToken] <SecureString> [-DomainId] <Object> [-Email] <String[]> [-WhatIf]
[-Confirm] [<CommonParameters>]
Add emails to the exclusion list of a TeamViewer Single Sign-On domain. Accounts with these email addresses do not need to login via Single Sign-On but use their TeamViewer account password instead.
PS /> Add-TeamViewerSsoExclusion -DomainId '45e0d050-15e6-4fcb-91b2-ea4f20fe2085' -Email 'user@example.test'
Adds the email address 'user@example.test' to the exclusion list of the given domain.
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
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
Object that can be used to identify the SSO domain to add exclusion entries to.
This can either be the SSO domain ID (as string or GUID) or a SsoDomain
object that has been received using the Get-TeamViewerSsoDomain
function.
Type: Object
Parameter Sets: (All)
Aliases: Domain
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
List of emails addresses to add to the exclusion list. The emails must be of the same email domain as the SSO domain, otherwise the command will fail.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
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
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.