[“Configure SAML”]

You can use the Security Assertion Markup Language (SAML) to authenticate users.

SAML SSO authentication

ThoughtSpot supports the Single Sign-On (SSO) authentication method with the Security Assertion Markup Language (SAML) authentication and authorization framework. With SAML SSO, users can authenticate to the SAML identity provider (IdP) at your federation to access the ThoughtSpot application, or the embedded ThoughtSpot content in an external web application. It also allows them to navigate seamlessly between different application interfaces with their existing credentials.

By default, local authentication is enabled. Use this article to learn how to configure a SAML integration with an external IdP.

About SAML authentication

The SAML SSO authentication involves several entities and components.

SAML entities

SAML is an XML standard that allows secure exchange of user authentication and authorization data between trusted partners. It enables the following entities to exchange identity, authentication, and authorization information:

Identity Provider (IdP)

The Identity Management system that maintains the user identity information. IdP acts as a SAML authority and authenticates SSO users. ThoughtSpot supports SAML authentication framework with popular Identity Providers such as Okta, Azure Active Directory, PingFederate, Microsoft AD FS, and Onelogin. This is not an exhaustive list. To determine if ThoughtSpot supports your preferred IdP, talk to your ThoughtSpot contact.

After you complete the SAML configuration in ThoughtSpot that this article describes, refer to your Identity Provider’s SAML documentation for specific information on setting up SAML with that IdP.
Service Provider (SP)

The provider of a business function or application service; for example ThoughtSpot. The SP relies on the IdP to authenticate users before allowing access to its services.
Federated user

A user whose identity information is managed by the IdP. The federated users have SSO credentials and authenticate to IdP to access various application services.

SAML assertion and attributes

Both SP-initiated and IdP-initiated authentication workflows rely upon assertions that are exchanged between the SAML endpoints through a web browser.

Some of the most commonly used elements are:

SAML assertion

The user authentication and authorization information issued by the IdP. SAML assertions contain all the information necessary for a service provider to confirm if the user identity is valid.
Metadata

Data in the XML format to establish interoperability between the IdP and SP. It contains the URLs of the endpoints, entity ID, and so on.
Assertion Services Consumer (ACS) URL

The endpoint URL to which the user’s browser sends the SAML response received from the IdP after authenticating a user.
Entity ID

A unique service name to identify the client application from which the SSO login request originates.
SAML attributes

The attributes associated with the user; for example, username and email address.

Enable SAML authentication

You need admin privileges to enable SAML SSO authentication. You can set up SAML through the shell on ThoughtSpot using a tscli-based configurator, or through the Admin Console.

Configuration prerequisites

Before you configure SAML, collect the following information:

❏	ThoughtSpot service address
❏	Service port
❏	Unique service name
❏	Skew time in seconds
❏	Protocol
❏	IDP Metadata XML File
❏	Automatically add SAML users to Thoughtspot
❏	Also use ThoughtSpot internal authentication

ThoughtSpot service address

A fully qualified and resolvable domain name for the ThoughtSpot service. For example, thoughtspot.thoughtspot-customer.com. If you do not have the DNS name, you can use the front-end IP address. However, using the DNS name instead of the IP address is a best practice.

Service port

Enter 443 in this box. This is the port of the server where your ThoughtSpot instance is running.

Unique service name

The unique key used by your Identity Provider to identify the client. For example, urn:thoughtspot:callosum:saml. You may know this as the Entity ID.

Skew time in seconds

The allowed skew time, after which the authentication response is rejected and sent back from the IDP. 86400 is a popular choice. The default is 3600.

Protocol

The connection protocol for ThoughtSpot. For example, https.

IdP Metadata XML File

The absolute path to your Identity Provider’s metadata file. This file is provided by your IDP. You need this file so that the configuration persists over upgrades. It is a best practice to set it up on persistent/HA storage (NAS volumes) or in the same absolute path on all nodes in the cluster. For example, idp-meta.xml. If your IDP needs an Assertion Consumer Service URL to create the metadata file, use https://<hostname_or_IP>:443/callosum/v1/saml/SSO. Note that this URL is case-sensitive.

Note: If your IdP does not allow you to import the IdP metadata XML file, you must map values manually. For the ThoughtSpot system to pick up certain attributes, you must map them to specific fields. Map the username you would like to use to NameId, map the email id of the user to mail, and optionally map the display name you would like to use to displayName. Starting in ThoughtSpot version 6.3.1, it is mandatory to fill out the mail field. If your company cannot meet this requirement, contact ThoughtSpot support.

Automatically add SAML users to Thoughtspot: (yes/no)

Choose whether or not to add SAML users to ThoughtSpot when they first authenticate. If you choose ‘yes’, then new users will be automatically created in ThoughtSpot upon first successful SSO login. If you choose ‘no’, then SAML users will not be added in ThoughtSpot upon first successful SSO login. Instead, you must add users manually or through Active Directory.

Also use ThoughtSpot internal authentication: (y/n)

If ‘y’, then ThoughtSpot local/internal users (including local administrative users) will still be authenticated outside the scope of SSO.

samlMaxAuthenticationAge (tscli configuration only)

By default, ThoughtSpot sets your samlMaxAuthenticationAge to 18114400 (seconds). If you experience an unauthorized error when logging in via SAML, your AuthnInstant value may be set to a different, older value. To resolve this issue, find your AuthnInstant value in the IDP login assertion. Set the samlMaxAuthenticationAge to a value older than that value.

This is only one reason why you may receive an unauthorized error when logging in via SAML; if updating your samlMaxAuthenticationAge value does not resolve this issue, contact ThoughtSpot Support.

You can only configure this setting when configuring SAML using tscli.

Configure SAML using tscli

Note: The configuration persists across updates to newer releases of ThoughtSpot.

To set up SAML on ThoughtSpot for user authentication, follow these steps:

Log in to the Linux shell using SSH.
Run the saml configure command to launch the interactive SAML configuration:
```
 tscli saml configure
```
Complete the configurator prompts with the information you collected in Configuration prerequisites.
When the configuration is complete, download ThoughtSpot’s metadata file, spring_saml_metadata.xml. This file contains the public key you need if you want to encrypt your SAML assertions. To download this file, navigate to https://<hostname-or-IP>/callosum/v1/saml/metadata/. The file automatically downloads.

Configure the IdP

To enable the IdP to recognize your host application and ThoughtSpot as a valid service provider, you must configure the IdP with required attributes and metadata. This includes the spring_saml_metadata.xml file that you downloaded in step 4 of Configure SAML using tscli.

ThoughtSpot supports SAML authentication with several identity and access management providers, such as Okta, Azure Active Directory, PingFederate, Microsoft AD FS, Onelogin and so on. If you want to use one of these providers as your IdP, make sure you read the SAML configuration steps described in the Identity provider’s documentation site.

To determine if ThoughtSpot supports your preferred IdP, contact ThoughtSpot support.

Complete your configuration of the IdP using the IdP’s SAML documentation. Upload or copy the contents of the spring_saml_metadata.xml to your IdP server. This file contains the public key you need if you want to encrypt your SAML assertions. If you did not download the spring_saml_metadata.xml file, navigate to https://<your_ThoughtSpot_hostname-or-IP>/callosum/v1/saml/metadata/. The file automatically downloads.

Note: When configuring SAML 2.0, make sure you map the SAML user attributes to appropriate fields. For example, you must map SAML user’s username to the NameId attribute in OneLogin. Similarly, in Okta, you must map the username to userPrincipalName. You must also map the email address of the user to the mail attribute, and optionally map the display name you would like to use to displayName. Starting in ThoughtSpot version 6.3.1, it is mandatory to fill out the mail field. If your company cannot meet this requirement, contact ThoughtSpot support. If your IdP does not allow you to import the IdP metadata XML file, you must map these values manually.

After you configure the IdP, open a Web browser and go to the ThoughtSpot login page. It should now show the Single Sign On option.

Configure SAML using the Admin Console

You need admin privileges to enable SAML SSO authentication.

Note: If you configure authentication through SAML, you cannot also configure authentication through Active Directory.

Configure the ThoughtSpot application instance on your IDP server.
Log into your ThoughtSpot application instance.
From the top navigation bar, select the Admin tab.
Select SAML from the side navigation bar that appears.
Click the Configure button in the middle of the screen.
Fill in the parameters with the information you collected in the Configuration prerequisites.
When the configuration is complete, download ThoughtSpot’s metadata file, spring_saml_metadata.xml. This file contains the public key you need if you want to encrypt your SAML assertions. To download this file, navigate to https://<hostname-or-IP>/callosum/v1/saml/metadata/. The file automatically downloads.

Note: ThoughtSpot adds external users, or users that authenticate through SAML or Active Directory, to the all group by default. This group has no privileges. You must manually assign users to ThoughtSpot groups to give them privileges, such as can upload user data, or can manage data.

Configure the IdP

To determine if ThoughtSpot supports your preferred IdP, contact ThoughtSpot support.

Note: When configuring SAML 2.0, make sure you map the SAML user attributes to appropriate fields. For example, you must map the SAML user’s username to the NameId attribute in OneLogin. Similarly, in Okta, you must map the username to userPrincipalName. You must also map the email address of the user to the mail attribute, and optionally map the display name you would like to use to displayName. Starting in ThoughtSpot version 6.3.1, it is mandatory to fill out the mail field. If your company cannot meet this requirement, contact ThoughtSpot support. If your IdP does not allow you to import the IdP metadata XML file, you must map these values manually.

After you configure the IdP, open a Web browser and go to the ThoughtSpot login page. It should now show the Single Sign On option.

Additional resources

As you develop your expertise in authentication and security, we recommend the following ThoughtSpot U course:

Single Sign On (SSO)

See other training resources at