Skip to main content
Community Hub

Set up Sigma

TL;DR

Create a Sigma API token and client ID, and give its owner the permissions Atlan needs to crawl Sigma

Your AI can read this via Docs MCPcurl -fsSL "https://docs.atlan.com/install-docs-mcp" | bashConnect
Who can do this?

You will probably need your Sigma administrator to complete these steps - you may not have access yourself.

Identify your organization's cloud​

You will need your organization's cloud information to determine the endpoint while authenticating in Atlan.

To identify your organization's cloud:

  1. Open your Sigma account.
  2. In the top right of the screen, click your profile avatar and then click Administration to open your Account page.
  3. On the Account page, under Site in General Settings, view the cloud information.

Create an API token and client ID​

To create an API token and client ID:

  1. Open your Sigma account.

  2. In the top right of the screen, click your profile avatar and then click Administration.

  3. From the left menu of the Administration page, click Developer Access.

  4. In the top right of the Developer Access page, click the Create New button.

  5. In the Create client credentials dialog, for Select privileges, click the Rest API checkbox, and then enter the following details:

    1. For Name, enter a meaningful name.
    2. For Owner, select the user you would like to associate with the token.
    3. Click Create to finish creating the API token.

  6. Once prompted, click Copy to copy and paste your API key secret in a secure location.

    warning

    The secret cannot be retrieved once this popover is closed.

  7. Your newly created API token will be listed in the Developer Access page. Hover over the token’s Client ID and click Copy.

Both the API token and the client ID are required for authentication in Atlan.

Verify necessary permissions​

The permissions that the owner of the API token needs depend on the Sigma admin API client switch on the Sigma credential in Atlan. The switch is on by default.

Admin API client​

If the Sigma admin API client switch is on, the owner of the API token must be a Sigma admin. Atlan crawls every workbook, dataset, and data model in your Sigma organization, with full data model lineage.

The Admin API access preflight check confirms that the owner has admin access. Atlan also runs this check before each crawl. If the owner isn't a Sigma admin, the check fails. To fix it, use an API token that a Sigma admin owns, or turn off the switch. Turning off the switch removes the assets that the owner can't access from Atlan at the next crawler run.

Non-admin API client​

If the Sigma admin API client switch is off, make sure that the owner of the API token has the following permissions:

  • Can View permission for all the Sigma workbooks and datasets you want to crawl.
  • Can Use permission for all the Sigma connections used in the workbooks and datasets.

Atlan crawls only the workbooks, datasets, and data models that the owner can access. Atlan doesn't catalog assets that the owner can't access, and data model lineage can be incomplete. Atlan skips the Admin API access preflight check and reports it as passed.

Grant permissions​

To grant permissions, follow the instructions in these links:

Next steps​

Crawl Sigma: Configure and run the crawler to extract metadata from Sigma.