Configure a Sigma OAuth application

This document guides you through steps to create a Sigma OAuth application in your IdP to enable authentication to be handled by your IdP. You can then configure Sigma to connect to your OAuth application, either as an authentication method for login to your Sigma organization, or to authenticate Sigma connections to your data platform, or both.

Follow the steps that match the type of IdP you are using:

• Configure a Sigma OAuth application in an external IdP
• Configure a custom OAuth application for Sigma in Databricks Authorization Server

Requirements

• A supported identity provider (IdP). Sigma supports Okta, Azure AD, Auth0, PingIndentity, or Databricks Authorization Server.

Configure a Sigma OAuth application in an external IdP

Follow these steps to configure an OAuth app for Sigma in an external IdP such as Okta, Azure AD, Auth0, or PingIdentity. If you are using Databricks Authorization Server, refer instead to Configure a custom OAuth application for Sigma in Databricks Authorization Server.

High-level overview

The exact implementation of these steps varies depending on your IdP. Visit your IdP’s documentation for detailed instructions.

1. Create an app for Sigma in your IdP
2. Add OAuth users to your app
3. Create an OAuth authorization server
4. Add an access policy for the authorization server
5. [optional] Create a security integration (Snowflake only)

Step 1: Create an app for Sigma in your IdP

First, create a Web OpenID Connect app within your IdP for Sigma. The exact configuration steps and wording of the options differ depending on your IdP.

Within the app, do the following:

1. Enable the authorization code grant type.
2. [optional] Enable the refresh token grant type. This step is only required if you specify the offline_access scope when you create an authorization server in Step 3: Create an authorization server.
3. [optional] To require Proof Key for Code Exchange (PKCE) for additional verification, select that option in your app configuration.

   📘

   PKCE is not supported for organization-level authentication, so if you do enable it, do not use this app to authenticate users to your Sigma organization. Instead, create a separate app for organization-level authentication that does not use PKCE.

4. [optional] If you want to use JSON Web Tokens (JWTs) to authenticate with a public key and private key instead of a client secret, select that option in your app configuration. In your IdP, this may be called "JWT bearer tokens" or "Public key / Private key".

   📘

   JWTs are not supported for organization-level authentication, so if you do enable JWT authentication, do not use this app to authenticate users to your Sigma organization. Instead, create a separate app for organization-level authentication that does not use JWTs.

5. [optional] If you select the option to use JWTs, provide Sigma's public cert when prompted. Use the URL that matches your deployment.

6. Set the login redirect URL that matches your deployment:

Creating your Sigma OAuth app generates a Client ID and (optionally) a Client Secret. These fields are required to complete your OAuth configuration in Sigma in a later procedure.

Step 2: Add OAuth users to your app

After creating your OAuth app, add a list of your OAuth users. If you use this OAuth configuration to authenticate connections to your data platform, then these users are mapped to both Sigma and your data platform.

All users must be granted sufficient privileges in the data platform that you want to use to run queries from Sigma.

Step 3: Create an OAuth authorization server

An authorization server is used to grant tokens to your users that identify them to Sigma and/or your data platform. Create an authorization server in your IdP that grants tokens with the following scopes:

For example, if you are configuring the authorization server to connect to Sigma and Snowflake, enter the following values:

The authorization server provides a metadata URI. The metadata URI is required to complete your OAuth configuration in Sigma in a later procedure.

The server also provides an issuer url and jws keys url, both of which are needed for the Snowflake security integration, which is required if you are using your OAuth app to connect to a Snowflake warehouse (step 5).

If you are using Okta, note that Okta requires Okta API Access Management to be enabled in your Okta instance to create an authorization server.

Step 4: Add an access policy for the authorization server

1. Create and/or assign an access policy to your new app (created in step 1). Access policies define rules for access and token lifetimes on an individual app.
2. Within the access policy, define access and refresh token lifetimes as desired for all grant types, users, and scopes.

Step 5: Create a security integration (Snowflake only)

Create a security integration in Snowflake to allow Snowflake to trust your IdP.

📘

This step is necessary only if you want to use this Sigma OAuth application to authenticate one or more Snowflake connections with OAuth. If you don't use Snowflake, or if you are configuring the OAuth application only for authenticating users to your Sigma organization, then this step of establishing the trust relationship between your authorization server and Snowflake is not necessary.

See the CREATE SECURITY INTEGRATION command reference in the Snowflake documentation. When creating the security integration, you need to provide the issuer url and jws keys url (created in step 3).

The following is an example of the SQL statement you run in Snowflake if Okta is your IdP, with placeholder values in angle brackets. The values vary depending on your IdP.

create security integration <name>
   type = external_oauth
   enabled = true
   external_oauth_type = okta
   external_oauth_issuer = 'https://<COMPANY>.okta.com/oauth2/<ID>'
   external_oauth_jws_keys_url = 'https://<COMPANY>.okta.com/oauth2/<ID>/v1/keys'
   external_oauth_token_user_mapping_claim = 'snowflake_username'
   external_oauth_snowflake_user_mapping_attribute = 'login_name'
   external_oauth_any_role_mode = 'ENABLE';

 

Configure a custom OAuth application for Sigma in Databricks Authorization Server

Enable a custom OAuth application in your Databricks account. To complete these steps, you need Account Admin privileges in Databricks. See What are account admins? in the Databricks documentation.See the Databricks documentation for detailed instructions:

• See Enable custom OAuth applications using the Azure Databricks UI for Databricks on Azure.
• See Enable custom OAuth applications using the Databricks UI for Databricks on AWS.

When you create the connection for the application in Databricks, you have several configuration options. Sigma requires the following configurations for your OAuth connection to work:

• Redirect URLs: Enter a redirect URL that matches your Sigma deployment.

• Access scopes: When you are prompted to select an access scope, select All APIs.
• Client secret: Enable the option to generate a client secret, as Sigma requires this for secure connection.

Record your client ID and client secret. You need these values for the Sigma configuration.

Determine the metadata URI for your Databricks Authorization Server

Determine the metadata URI that Sigma will require to complete the OAuth configuration. The metadata URI includes the unique ID for your Databricks account. For information about how to retrieve your Databricks account ID, see Locate your account ID in the Databricks documentation.

Form your metadata URI using your Databricks account ID, following this pattern: