This article applies to TeamViewer customers with an Enterprise/Tensor license.

TeamViewer Single Sign-On (SSO) aims to reduce the user management efforts for large companies by connecting TeamViewer with identity providers and user directories.

Requirements

To use TeamViewer Single Sign-On, you need

  • a TeamViewer version 13.2.1080 or newer
  • a SAML 2.0 compatible identity provider (IdP)*
  • a TeamViewer account to access the Management Console and add domains
  • access to the DNS management of your domain to verify the domain ownership
  • a TeamViewer Tensor license.

* Currently we only support Centrify, Okta, Azure, OneLogin, ADFS but we are working on supporting more IdPs in the future. The above IdPs have been tested and detailed steps to set up one of these IdP can be found in this document. We have been informed that Gsuite is currently not compatible and we have it on the roadmap for support.

Note: If you use a different IdP, please use the technical information to set up your IdP manually.

Hint: When adding a domain for Single Sign-On, it is recommended to add the owning account to the exclusion list. The reason for this is a fallback scenario that you keep the access to the domain configuration even if the IdP is not working.
Example: The TeamViewer Account "admin@example.com" adds domain „example.com“ for Single Sign-On. After adding the domain, the email address "admin@example.com" should be added to the exclusion list.

TeamViewer Management Console (MCO) Configuration

Single Sign-On (SSO) is activated on a domain level for all TeamViewer accounts using an email address with this domain. Once activated, all users that sign into a corresponding TeamViewer account are redirected to the identity provider that has been configured for the domain. This step is required independent of which IdP is used.

For security reasons and to prevent abuse, it is required to verify the domain ownership before the feature is activated.

Add a new domain

To activate SSO, log in to Management Console and select the Single Sign-On menu entry. Click on Add domain and enter the domain you want to activate SSO for.

You also need to provide you identity provider’s metadata. There are three options available to do so:

  • via URL: enter your IdP metadata URL into the corresponding field
  • via XML: select and upload your metadata XML
  • Manual configuration: manually enter all necessary information. Please note that the public key must be a Base64 encoded string.

Add domain.png

Create custom identifier

After the domain has been added, the custom identifier can be generated. This custom identifier is not stored by TeamViewer, but is used for the initial configuration of SSO. It must not be changed at any point in time, since this will break Single Sign-On and a new setup will be necessary. Any random string can be used as customer identifier. This string is later required for the configuration of the IdP.

CustomIdentifier1.png  CustomIdentifier2.png  

Verify domain ownership

After a domain has been added successfully, you need to verify the domain ownership.
Single Sign-On will not be activated before the domain verification is completed.

To verify the domain, please create a new TXT record for your domain with the values shown on the verification page.

Note: The verification process can take several hours because of the DNS system.

20180910_domain_verification.png

The dialog to add a TXT record might look similar to:

AddDNSrecord.png

Note: Depending on your domain management system, the description of the input fields may vary.

After creating the new TXT record, start the verification process by clicking on the “Start Verification” button.

Please note that the verification process can take several hours because of the DNS system.

Hint: TeamViewer will look for the TXT verification record for 24 hours after starting the verification. In case we cannot find the TXT record within 24 hours, the verification fails and the status is updated accordingly. You need to restart the verification through this dialog in this case. 

 

Identity Provider Setup

Each identity provider requires its own configuration, which is covered on dedicated knowledge base articles:

Active Directory Federation-Services (ADFS)

Azure Active Directory

Centrify

G Suite

Okta

OneLogin

 

TeamViewer Client Configuration

TeamViewer is compatible to Single Sign-On starting from version 13.2.1080.
Previous versions do not support Single Sign-On and can not redirect users to your identity provider during the login. The client configuration is optional, but allows to change the used browser for the SSO login of the IdP.

The TeamViewer client will use an embedded browser for the identity provider authentication by default. If you would prefer to use the default browser of the operating system, you can change this behavior via the following registry key:

HKEY_CURRENT_USER\Software\TeamViewer\SsoUseEmbeddedBrowser = 0 (DWORD)

Note: You need to restart the TeamViewer client after creating or changing the registry.

Technical information

This section lists the technical details of the TeamViewer SAML Service Provider (SP). This data might be relevant for adding other IdPs than the ones described above.

SAML Service Provider Metadata:

SP Metadata URL

https://sso.teamviewer.com/saml/metadata.xml

Entity ID

https://sso.teamviewer.com/saml/metadata

Audience

https://sso.teamviewer.com/saml/metadata

Assertion Customer Service URL

https://sso.teamviewer.com/saml/acs

Assertion Consumer Service URL

https://sso.teamviewer.com/saml/acs

Assertion Consumer Service Bindings

urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST
urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirec

SAML Request Signature Algorithm

http://www.w3.org/2001/04/xmldsig-more#rsa-sha256
TeamViewer supports SHA-256 as signature algorithm. We require the SAML assertion to be signed, while signing the SAML response is optional but recommended.

NameID

Unspecified

 

 Required SAML Response Claims:

  • http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress
    This attribute should be mapped to the email address of the user that wants to sign-in. The email address needs to be the same as configured for the TeamViewer account. The mapping/comparison is done in a case-in-sensitive way.

  • http://sso.teamviewer.com/saml/claims/customeridentifier

    This attribute should return a customer-specific identifier.

    TeamViewer requires a customer identifier as custom claim in the SAML response for the initial configuration of Single Sign-On accounts.
    The customer identifier is not stored by TeamViewer. Changing it later will break Single Sign-On and a new setup will be necessary.

    Any random string can be used as customer identifier.


Signature & Encryption Certificate (Public Key)

The public key of the certificate that is used to sign SAML requests and for the encryption of SAML responses can be obtained by executing the following PowerShell command:

"-----BEGIN PUBLIC KEY-----`n" + `
((Select-Xml `
-Content ((Invoke-WebRequest `
https://sso.teamviewer.com/saml/metadata.xml).Content) `
-xpath "//*[local-name()='X509Certificate']").Node[0].'#text') + `
"`n-----END PUBLIC KEY-----" `
| Out-File -FilePath "sso.teamviewer.com - saml.cer" -Encoding ascii

The command downloads the metadata, extracts the public key and writes it to a file.

Version history
Revision #:
46 of 46
Last update:
3 hours ago
Updated by: