Skip to content

Latest commit

 

History

History
140 lines (99 loc) · 2.9 KB

Remove-TeamViewerSsoExclusion.md

File metadata and controls

140 lines (99 loc) · 2.9 KB
external help file Module Name online version schema
TeamViewerPS-help.xml
TeamViewerPS
2.0.0

Remove-TeamViewerSsoExclusion

SYNOPSIS

Remove emails from the exclusion list of a TeamViewer Single Sign-On domain.

SYNTAX

Remove-TeamViewerSsoExclusion [-ApiToken] <SecureString> [-DomainId] <Object> [-Email] <String[]> [-WhatIf]
 [-Confirm] [<CommonParameters>]

DESCRIPTION

Remove emails from 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.

EXAMPLES

Example 1

PS /> Remove-TeamViewerSsoExclusion -DomainId '45e0d050-15e6-4fcb-91b2-ea4f20fe2085' -Email 'user@example.test'

Removes the email address 'user@example.test' from the exclusion list of the given domain.

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

-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

-DomainId

Object that can be used to identify the SSO domain to remove exclusion entries from. 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

-Email

List of emails addresses to remove from the exclusion list.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByValue)
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

OUTPUTS

NOTES

RELATED LINKS

Get-TeamViewerSsoDomain

Get-TeamViewerSsoExclusion

Add-TeamViewerSsoExclusion