Sync users and groups from LDAP

Use this procedure to synchronize your ThoughtSpot system with an LDAP server through Active Directory.


Before synchronizing users and groups, set up integration with LDAP using Active Directory. Then, collect the following information:

  • IP address and port of the server where your ThoughtSpot instance is running.

    This hostport must be in the following format http(s)://<host>:<port> or http(s)://<domain>.

  • Administrator login username and password for your ThoughtSpot instance.

  • URL of the LDAP server, or hostport.

    For example, ldap://

  • Login username and password for the LDAP system.

    An example username would be [email protected]

  • Distinguished Name (DN) for the base to start searching for users in the LDAP system.

    For example, DC=ldap,DC=thoughtspot,DC=com

  • The Python synchronization script, in case you want to modify it or create your own, is here:


Fetch users and groups from LDAP with Active Directory

There are two ways for you to fetch users and groups from LDAP and populate them into your ThoughtSpot system:

  • Run the synchronization script in interactive mode, which walks you through the process (shown here).

  • Create your own Python script by using the ThoughtSpot Python APIs. If you need details on the Python APIs, contact ThoughtSpot Support. If you choose this method, you can run the script periodically using a cron job.

When you run the synchronization script, you perform a one-time sync. You must schedule a recurring sync using a cron job or your own scheduling tool to keep your ThoughtSpot users up to date with your users in LDAP.

Run the sync script

To run the LDAP sync script in interactive mode:

  1. Log in to the Linux shell using SSH.

  2. Run the command to start the script:

    python3 interactive
  3. Answer the prompts using the information you collected above. Specify 2 for the scope if you would like to sync all groups, including subgroups. For example:

     Complete URL of TS server in format "http(s)://<host>:<port>":
     Disable SSL authentication to TS server (y/n): y
     Login username for ThoughtSpot system: admin
     Login password for ThoughtSpot system: 12345
     Complete URL of server where LDAP server is running in format ldap(s)://<host>:<port>: ldap://
     Login username for LDAP system: [email protected]
     Login password for LDAP system: 12345
     Syncs user and groups between LDAP and TS systems (y/n): y
     Delete entries in ThoughtSpot system that are not currently in LDAP tree being synced (y/n): n
     Distinguished name for the base to start searching groups in LDAP System: DC=ldap,DC=thoughtspot,DC=com
     Scope to limit the search to (choice number)
     0:base Searching only the entry at the base DN
     1:one Searching all entries on level under the base DN - but not including the base DN
     2:tree Searching of all entries at all levels under and including the specified base DN: 2
     Filter string to apply the search to: (|(CN=TestGroupAlpha)(CN=TestGroupBeta))

    Answering this prompt is optional. If left blank, the default value of '(CN=*)'will be used.

     Apply sync recursively, i.e. Iterates through group members and creates member groups, users and relationships in a recursive way. (y/n): n

    This prompt is asking if you would like to include group members even if they do not belong to the current sub tree that is being synced.

  4. Alternatively, to input your own shorthand script commands:

    Issue the Python script commands, supplying all this information, following this format example:

     python3 script \
     –-ts_hostport <ts_hostport> \
     --disable_ssl \
     --ts_uname <ts_username> \
     --ts_pass <ts_password> \
     --ldap_hostport '<ldap_hostport>' \
     --ldap_uname '<ldap_username>' \
     --ldap_pass '<ldap_password>' \
     --sync \
     --purge \
     --basedn 'DC=ldap,DC=thoughtspot,DC=com' \
     --filter_str '(|(CN=TestGroupAlpha)(CN=TestGroupBeta))' \
     --include_nontree_members \
     --user_identifier <user_identifier> \
     --authdomain_identifier <authdomain_identifier> \
     --email_identifier <email_identifier>

    The bottom half of the preceding command targets sub trees under the DC called TestGroupAlpha and TestGroupBeta, and iterates through them recursively to create/sync users, groups, and their relationships in the ThoughtSpot system. It also deletes any other entities created in the ThoughtSpot system from this LDAP system that are not currently being synced.

  5. When the ThoughtSpot search engine finishes indexing, your new users should appear in the ThoughtSpot application. To check if the ThoughtSpot search engine is indexing, run the following command:

 tscli cluster status command-line switches

The following table provides a description of each command-line switch available for the syncUsersAndGroups python script.

Switch Description

--ts_hostport <ts_hostport>

ThoughtSpot cluster host port. Default port is 8088.


Controls the communication between the sync script and the ThoughtSpot cluster. It disables SSL communications between the script and the cluster ONLY, and prevents the need to provide SSL certs during the script execution in order to create users and groups.


ThoughtSpot cluster username. The admin user is usually used.


ThoughtSpot cluster password.


AD/LDAP server port that is queried. Default is 389.


Username for the LDAP/AD server.

--ldap_pass <ldap_password>

Password for the LDAP/AD server.


Syncs users and groups which match the basedn and filter_str queries to your ThoughtSpot cluster.


Purges any users that exist in ThoughtSpot, but not in AD.


Place in the directory that will be searched for users.


Further filters results from your base DN.


Includes group members from LDAP/AD even if they do not belong to the current subtree that is being synced.

--user_identifier <user_identifier>

User name identifier key for user creation or sync.

--authdomain_identifier <authdomain_identifier>

Override domain name to be appended to user identifier in user name.

--email_identifier <email_identifier>

Email identifier key for user creation or sync.


Provides additional logs in case of failure or other errors.

Was this page helpful?