Create a Basic Authentication Connector

The basic authentication boilerplate is a connector that ingests Excel data and uses the built-in TACO Excel file parser from a basic authentication endpoint.

Use cases


To create your basic authentication connector, we recommend that you first create a sample basic authentication connector and edit the generated files. It’s easier to get all the files and directory structure your connector needs by just using an existing example.

To create your basic authentication connector, do the following steps.

Step 1: Create a boilerplate basic authentication connector

  1. Enter the following command to create the connector:

    taco create my-basic-auth-connector --boilerplate basic-auth 

    This creates a directory with the earthquake data boilerplate code, which is included with the toolkit.

  2. Change directories to the my-basic-auth-connector directory.
    cd my-basic-auth-connector
  3. Build the connector by entering the following command:

    taco build

    This command clears any previous or existing build caches, then installs the dependencies, then builds the frontend code and the backend code (handlers), then copies the connector.json file (the configuration file).

Step 2: Configure your connector’s properties

In your new basic authentication connector directory, find and open the connector.json file.

  "name": "my-basic-auth-connector",
  "version": "1.0.0",
  "tableau-version": {
    "min": "2022.3"
  "vendor": {
    "name": "vendor-name",
    "support-link": "",
    "email": ""
  "permission": {
    "api": {
      "https://*": [
  "auth": {
    "type": "custom"
  "window": {
    "height": 800,
    "width": 600

Make the following changes:

  1. Change the general properties.

    Name Value
    name Your connector’s directory name
    displayName Your connector’s name. This is the name that appears in Tableau connectors area.
    version Your connector’s version
    min The earliest Tableau version your connector supports
  2. Change the company properties.

    Name Value Your company name Your company’s URL Your company’s email
  3. Change the permissions.

    Name Value
    permission.api The URI for the API that the connector is allowed to access, along with the methods (POST, GET, PUT, PATCH, DELETE) that the connector is allowed to use.
  4. Verify the authentication value.

    Name Value
    auth.type Set to custom

    For more information about authentication, see the Authentication section in the Considerations for Building Your Connector topic.

  5. Change the HTML pane size.

    Name Value
    window.height The height of the connector HTML pane
    window.width The width of the connector HTML pane

Step 3: Edit the user interface

When you open a web data connector in Tableau, the connector displays an HTML page that links to your JavaScript code and to your connector’s handlers. Optionally, this page can also display a user interface for your users to select the data that they want to download.

To create a user interface (UI) for your connector, open the /app/index.html file and make any edits for your connector.

<!DOCTYPE html>

  <title>Basic Auth Sample Connector</title>
  <meta http-equiv="Cache-Control" content="no-store" />
  <link rel="icon" href="data:,">
  <link href="index.css" rel="stylesheet" />
  <script src="index.ts" type="module" defer></script>

  <p id="error" style="display: block; margin-top: 2em; height: 5px; text-align: center; color: red;"></p>

  <div class="box m-auto ">
    <div class="card">
      <div class="card-header">
        Basic Auth Sample Connector

      <div class="card-body">
        <label for="userName" class="form-label">User Name</label>
        <input type="text" id="username" class="form-control mb-3" placeholder="User Name">

        <label for="Password" class="form-label">Password</label>
        <input type="password" id="password" class="form-control mb-4" placeholder="Password">

        <div class=" text-center">
          <button type="button" class="btn btn-success" id="submitButton" disabled>
            Please wait while settings load...




Some notes about what the code is doing:

Step 4: Edit the connector object

Now that you’ve created a user interface, it’s time to edit the JavaScript code for the connector’s button. The code is in the /app/index.js file.

Step 5: Update the fetcher file

If your data is complex and needs preprocessing, use the TACO Toolkit library to prepare your data. The following is the default code in the handlers/DataFetcher.js file that gets the data:

import { Fetcher, FetchUtils, FetchOptions, getBasicAuthHeader } from '@tableau/taco-toolkit/handlers'

export default class DataFetcher extends Fetcher {
  async *fetch({ secrets }: FetchOptions) {
    const { username, password } = secrets
    const headers = getBasicAuthHeader(username, password)

    // PLACEHOLDER: the url is NOT real endpoint.
    // Replace the url with actual endpoint that supports basic auth for corresponding file type.
    // Note: the permission setting in connector.json also needs to be updated accordingly.
    const url = ''

    yield await FetchUtils.loadExcelData(url, { headers })

For information about FetchUtils.loadExcelData, see loadExcelData

Step 6: Build your connector

Enter these commands to build, pack, and run your new connector:

taco build
taco pack
taco run Desktop