Skip to main content

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).
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.

Connector Setup

1

Open the connector wizard

Navigate to Sources and click Add. Select Sigma from the source type grid.
2

Authenticate

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).
3

Configure workspace scope

Use the Workspaces field to restrict onboarding to specific workspaces. Assets in workspaces not listed are not catalogued.
4

Job schedules

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.
5

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.

Next Steps

What We Collect

See the full field-level breakdown of every metadata object Prizm extracts.

FAQ

Common questions about credentials, scoping, and permissions.

Troubleshooting

Diagnose connection failures, permission errors, and timeouts.