This guide describes a feature of the dbt Cloud Enterprise plan. If you’re interested in learning more about an Enterprise plan, contact us at email@example.com.
dbt Cloud Enterprise supports OAuth authentication with Snowflake. When Snowflake OAuth is enabled, users can authorize their Development credentials using Single Sign On (SSO) via Snowflake rather than submitting a username and password to dbt Cloud. If Snowflake is setup with SSO through a third-party identity provider, developers can use this method to log into Snowflake and authorize the dbt Development credentials without any additional setup.
Configuring a security integration
To enable Snowflake OAuth, you will need to create a security integration in Snowflake to manage the OAuth connection between dbt Cloud and Snowflake.
Create a security integration
In Snowflake, execute a query to create a security integration. Please find the complete documentation on creating a security integration for custom clients here. You can find a sample
create or replace security integration query below.
CREATE OR REPLACE SECURITY INTEGRATION DBT_CLOUDTYPE = OAUTHENABLED = TRUEOAUTH_CLIENT = CUSTOMOAUTH_CLIENT_TYPE = 'CONFIDENTIAL'OAUTH_REDIRECT_URI = 'https://cloud.getdbt.com/complete/snowflake'OAUTH_ISSUE_REFRESH_TOKENS = TRUEOAUTH_REFRESH_TOKEN_VALIDITY = 7776000;
Note: Only Snowflake account administrators (users with the
ACCOUNTADMIN role) or a role with the global
CREATE INTEGRATION privilege can execute this SQL command.
|OAUTH_REDIRECT_URI||Required. If dbt Cloud is deployed on-premises, use the domain name of your application instead of |
|OAUTH_REFRESH_TOKEN_VALIDITY||Required. This configuration dictates the number of seconds that a refresh token is valid for. Use a smaller value to force users to re-authenticate with Snowflake more frequently.|
Additional configuration options may be specified for the security integration as needed.
Configure a Connection in dbt Cloud
The Database Admin is responsible for creating a Snowflake Connection in dbt Cloud. This Connection is configured using a Snowflake Client ID and Client Secret. When configuring a Connection in dbt Cloud, select the "Allow SSO Login" checkbox. Once this checkbox is selected, you will be prompted to enter an OAuth Client ID and OAuth Client Secret. These values can be determined by running the following query in Snowflake:
withintegration_secrets as (select parse_json(system$show_oauth_client_secrets('DBT_CLOUD')) as secrets)selectsecrets:"OAUTH_CLIENT_ID"::string as client_id,secrets:"OAUTH_CLIENT_SECRET"::string as client_secretfromintegration_secrets;
Enter the Client ID and Client Secret into dbt Cloud to complete the creation of your Connection.
Authorize Developer Credentials
Once Snowflake SSO is enabled, users on the project will be able to configure their credentials in their Profiles. By clicking the "Connect to Snowflake Account" button, users will be redirected to Snowflake to authorize with the configured SSO provider, then back to dbt Cloud to complete the setup process. At this point, users should now be able to use the dbt IDE with their development credentials.
SSO OAuth Flow Diagram
Once a user has authorized dbt Cloud with Snowflake via their identity provider, Snowflake will return a Refresh Token to the dbt Cloud application. dbt Cloud is then able to exchange this refresh token for an Access Token which can then be used to open a Snowflake connection and execute queries in the dbt Cloud IDE on behalf of users.
NOTE: The lifetime of the refresh token is dictated by the OAUTH_REFRESH_TOKEN_VALIDITY parameter supplied in the “create security integration” statement. When a user’s refresh token expires, the user will need to re-authorize with Snowflake to continue development in dbt Cloud.
Setting up multiple dbt Cloud projects with Snowflake 0Auth
If you are planning to set up the same Snowflake account to different dbt Cloud projects, you can use the same security integration for all of the projects.
How do I use the Blocked Roles List with dbt Cloud?
Invalid consent request
When clicking on the
Connect Snowflake Account successfully redirects you to the Snowflake login page, but you receive an
Invalid consent request error, your Snowflake user may not have access to the Snowflake role defined on the development credentials in dbt Cloud. Double-check that you have access to that role and if the role name has been correctly entered in as Snowflake is case sensitive.