Prerequisites
- A Sigma member with the Admin account type, to create the credentials
- A Sigma member with the Admin account type, to own the credentials. This can be the same member.
- The warehouse that Sigma reads from, connected to Sidecar. For example, see Snowflake.
1. Choose who owns the credentials
Sigma API credentials belong to one member of your organization. Sigma returns only the workbooks and data models that this member can access, with the permissions of the member’s account type. Give the owner the Admin account type. Sidecar can then list every workbook and data model in your organization, including those in workspaces that aren’t shared with the owner. If Sidecar can list a workbook but can’t read its details, the Sidecar team tells you which workspaces to share with the owner.2. Create API client credentials
- In Sigma, select your user avatar, then select Administration.
- In the side panel, select Developer access.
- Copy the API base URL at the top of the page. You share it with Sidecar in step 5.
- Click Create new.
- Under Select scopes, select REST API.
- For Name, enter
Sidecar. - (Optional) For Description, enter
Metadata sync for Sidecar. - For Owner, select the member from step 1.
- Click Create.
- Copy the Client ID and Client secret, and save them in a password manager.
The API base URL depends on the cloud that hosts your Sigma organization, for example
https://aws-api.sigmacomputing.com. Sigma lists every base URL in Identify your API request URL.3. (Optional) Allow Sidecar’s IP address
Skip this step if your organization doesn’t restrict Sigma access with an IP allowlist.- In Sigma, select your user avatar, then select Administration.
- In the side panel, select Authentication.
- In the IP address section of the IP allowlist, select Add.
- For Scope, select API.
- For IP address or CIDR range, enter
44.236.246.98/32, and enterSidecaras the description. - Click Save.
4. (Optional) Test the credentials
To confirm that the credentials work and that the owner has the Admin account type, run two requests. Replace<base_url>, <client_id>, and <client_secret> with your values.
- Request an access token:
The response contains an
access_token. - List workbooks across your organization with that token:
The response lists up to five workbooks. If the request fails, check that the owner has the Admin account type.
5. Connect Sigma to Sidecar
Provide the following information to the Sidecar team. Send the client secret through a password manager share or another secure channel, not in a Slack message.What Sidecar reads
Apart from the request for an access token, Sidecar sends onlyGET requests to the Sigma REST API. It reads:
- Workbook names, paths, and version numbers, and the email addresses of their owners
- Page and element names, and the SQL that Sigma generates for each element
- Data model names and elements
- Lineage between elements, data models, custom SQL, and warehouse tables
- Connection names, and the database, schema, and table names that elements read
The SQL that Sigma generates can include values that people enter in workbook filters and controls.
Revoke access
To disconnect Sidecar, revoke its credentials in Sigma:- In Sigma, select your user avatar, then select Administration.
- In the side panel, select Developer access.
- Find the
Sidecarcredentials, click More, and select Revoke.