Sigma

This guide will walk you through how to set up a Sigma connection in the Datalogz Control Tower using OAuth client credentials (Client ID and Client Secret) for authentication. This is Sigma's recommended method for programmatic, application-level access to the Sigma REST API without a user in the loop.

Below follows Sigma's documentation for generating API client credentials and identifying your API host.

Setup Overview

Below is the order of operations for completing the Sigma connector setup

  1. Confirm your Sigma account has Admin access and the API is enabled

  2. Identify your Sigma API base URL for your cloud and region

  3. Generate API client credentials (Client ID and Client Secret) in Sigma

  4. Create a Sigma connector in the Datalogz Control Tower

Confirm Admin access and API availability

  1. You must be a member of the Admin account type in Sigma to generate API client credentials. See Sigma's account type documentation for details.

  2. Your Sigma plan must include API access. If you're unsure, contact your Sigma account team to confirm the API is enabled for your organization.

Note: The credentials you generate inherit the permissions of the user account you assign them to. We recommend creating a dedicated service account user in Sigma (rather than tying credentials to an individual person) so that access is not disrupted if that person leaves the organization.

Identify your Sigma API base URL

Sigma hosts customers across multiple clouds (AWS, GCP, Azure) and regions. The correct API base URL depends on where your Sigma organization is provisioned.

  1. Log in to Sigma and navigate to Administration > Developer Access

  2. Copy the API base URL

Note: If you want to better understand Sigma's hosted cloud regions, check Sigma's API host reference table. Common examples:

  • AWS US (West): https://aws-api.sigmacomputing.com

  • AWS US (East): https://api.us-a.aws.sigmacomputing.com

  • GCP: https://api.sigmacomputing.com

  • Azure: https://api.us-a.azure.sigmacomputing.com

The API Base URL will be needed for the Sigma Connector setup in the Datalogz Control Tower. Using the wrong host will cause authentication to fail even with valid credentials.

Generate API client credentials in Sigma

  1. In Sigma, navigate to Administration > Developer Access

  2. Click Create New

  3. Select REST API as scope.

  4. Enter a Name (e.g., Datalogz Control Tower) and an optional Description

  5. Select the Owner for the credentials

    1. Note: We recommend a dedicated service account user. The credentials inherit this user's account type and permissions.

  6. Click Create

  7. Copy the Client ID and the Client Secret that are displayed

Create a Sigma connector in the Datalogz Control Tower

  1. Log in to your Datalogz account

  2. Navigate to your organization's connectors

  3. Select New Connector

  4. Select Sigma

  5. Enter the following information obtained in the previous steps

    1. API Base URL (e.g., https://aws-api.sigmacomputing.com)

    2. Client ID

    3. Client Secret

  6. Click Next

  7. Select Include personal workspaces if you want to ingest assets in account level workspaces.

  8. Select the Workspaces you'd like to monitor.

  9. Click Next

  10. Enter a Connector Name

  11. Select the snapshot frequency, e.g., Weekly or Daily

  12. Click Next

  13. Click Confirm and Finish

Last updated