> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dqlabs.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Sigma Setup

> Prerequisites, authentication options, and step-by-step instructions for connecting Sigma to Prizm.

<script type="application/ld+json">
  {`{
            "@context": "https://schema.org",
            "@type": "TechArticle",
            "headline": "Sigma Setup",
            "description": "Prerequisites, authentication options, and step-by-step instructions for connecting Sigma to Prizm.",
            "url": "https://docs.dqlabs.ai/sources/sigma/setup",
            "publisher": {
              "@type": "Organization",
              "name": "DQLabs Inc",
              "logo": "https://media.brand.dev/332adc35-5bc4-4d2b-bf78-256aa4a5e414.svg"
            }
            }`}
</script>

## Prerequisites

Create a Sigma service account and generate a Client ID / Client Secret pair scoped to read-only access before connecting. Note the API base URL for your Sigma deployment (e.g. `https://aws-api.sigmacomputing.com`).

<Note>
  Sigma issues API credentials only as a Client ID + Client Secret pair — there is no separate API key format. Username/password is a legacy authentication path Sigma does not recommend for production.
</Note>

## Connector Setup

<Steps>
  <Step title="Open the connector wizard">
    Navigate to **Sources** and click **Add**. Select **Sigma** from the source type grid.

    | Field           | Description                                                     |
    | :-------------- | :-------------------------------------------------------------- |
    | Connection Name | A label for this instance (e.g., sigma-prod)                    |
    | Host URL        | Sigma API base URL (e.g., `https://aws-api.sigmacomputing.com`) |
  </Step>

  <Step title="Authenticate">
    <Tabs>
      <Tab title="Client ID + Client Secret (Recommended)">
        | Field         | Description                                                               |
        | :------------ | :------------------------------------------------------------------------ |
        | Client ID     | Sigma Client ID for the service account                                   |
        | Client Secret | Sigma Client Secret; encrypted in DQLabs Vault and never shown after save |
      </Tab>

      <Tab title="OAuth 2.0 (GCP IAP)">
        For enterprise deployments already using GCP IAP, credentials are managed via HashiCorp Vault with automatic token refresh on the Vault lease. Contact your Prizm administrator to configure this path.
      </Tab>
    </Tabs>

    | Field      | Description                                                                               |
    | :--------- | :---------------------------------------------------------------------------------------- |
    | Workspaces | Comma-separated list of workspace names to include; leave blank to include all workspaces |

    Click **Test Connection** to validate credentials — this lists the workspaces the account can access before save is allowed. Invalid credentials return a structured error identifying the specific failure (invalid client, wrong host, insufficient scope).
  </Step>

  <Step title="Configure workspace scope">
    Use the Workspaces field to restrict onboarding to specific workspaces. Assets in workspaces not listed are not catalogued.
  </Step>

  <Step title="Job schedules">
    | Job Type              | Frequency      | Objects Covered                                             |
    | :-------------------- | :------------- | :---------------------------------------------------------- |
    | Catalog / Metadata    | Every 24 hours | Workspaces, Workbooks, Pages, Data Elements, Datasets, Tags |
    | Operational / Refresh | Every 1 hour   | Workbook `last_updated`, Dataset refresh status             |
    | Usage / Adoption      | Every 24 hours | Usage logs, view counts, unique users                       |

    <Note>
      Usage and Reliability metrics depend on Sigma's audit log / query log access, which requires a Premier-tier Sigma account with logging enabled — they are not available on all Sigma plans.
    </Note>
  </Step>

  <Step title="Save and verify">
    Click **Save**. Prizm runs an initial catalog crawl — assets appear in the catalog within a few minutes. Navigate to **Settings → Connectors → Logs** to monitor scan progress.
  </Step>
</Steps>

## Next Steps

<CardGroup cols={2}>
  <Card title="What We Collect" icon="database" href="/sources/sigma/what-we-collect">
    See the full field-level breakdown of every metadata object Prizm extracts.
  </Card>

  <Card title="FAQ" icon="circle-question" href="/sources/sigma/faq">
    Common questions about credentials, scoping, and permissions.
  </Card>

  <Card title="Troubleshooting" icon="wrench" href="/help/troubleshooting">
    Diagnose connection failures, permission errors, and timeouts.
  </Card>
</CardGroup>