Adding help file for TeamViewerSsoInclusion

Docs/Help/Add-TeamViewerSsoInclusion.md

@@ -0,0 +1,137 @@
+---
+external help file: TeamViewerPS-help.xml
+Module Name: TeamViewerPS
+online version: https://github.com/teamviewer/TeamViewerPS/blob/main/Docs/Help/Add-TeamViewerSsoInclusion.md
+schema: 2.0.0
+---
+
+# Add-TeamViewerSsoInclusion
+
+## SYNOPSIS
+
+Add emails to the inclusion list of a TeamViewer Single Sign-On domain.
+
+## SYNTAX
+
+```powershell
+Add-TeamViewerSsoInclusion [-ApiToken] <SecureString> [-DomainId] <Object> [-Email] <String[]> [-WhatIf]
+ [-Confirm] [<CommonParameters>]
+```
+
+## DESCRIPTION
+
+Add emails to the inclusion list of a TeamViewer Single Sign-On domain.
+Only accounts with these email addresses will be able to login via Single
+Sign-On.
+
+## EXAMPLES
+
+### Example 1
+
+```powershell
+PS /> Add-TeamViewerSsoInclusion -DomainId '45e0d050-15e6-4fcb-91b2-ea4f20fe2085' -Email '[email protected]'
+```
+
+Adds the email address '<[email protected]>' to the inclusion list of the given
+domain.
+
+## PARAMETERS
+
+### -ApiToken
+
+The TeamViewer API access token.
+
+```yaml
+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.
+
+```yaml
+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 add inclusion 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.
+
+```yaml
+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 add to the inclusion list.
+The emails must be of the same email domain as the SSO domain, otherwise the
+command will fail.
+
+```yaml
+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.
+
+```yaml
+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](http://go.microsoft.com/fwlink/?LinkID=113216).
+
+## INPUTS
+
+## OUTPUTS
+
+## NOTES
+
+## RELATED LINKS
+
+[Get-TeamViewerSsoDomain](Get-TeamViewerSsoDomain.md)