Snowflake¶
Supported authentication¶
- Username/password
- Snowflake OAuth
- External OAuth with Okta or AzureAD
Username/password¶
Prerequisites¶
The following is required before connecting to Snowflake in DataRobot:
- A Snowflake account
OAuth with security integrations
If you create a security integration when configuring OAuth, you must specify the OAUTH_REDIRECT_URI
as https://<datarobot_app_server>/account/snowflake/snowflake_authz_return
.
Required parameters¶
In addition to the required fields listed below, you can learn about other available configuration options in the Snowflake documentation.
Required field | Description | Documentation |
---|---|---|
address |
A connection object that stores a secure connection URL to connect to Snowflake. Example: {account_name}.snowflakecomputing.com |
Snowflake documentation |
warehouse |
A unique identifier for your virtual warehouse. | Snowflake documentation |
db |
A unique identifier for your database. | Snowflake documentation |
Snowflake OAuth¶
Prerequisites¶
The following is required before connecting to Snowflake in DataRobot:
- A Snowflake account
- Snowflake OAuth configured
Set up the connection in DataRobot¶
When connecting with OAuth parameters, you must create a new data connection.
To set up a data connection using OAuth:
-
Follow the instructions for creating a data connection and testing the connection.
-
After clicking Test Connection, a window appears and you must enter your Snowflake client ID and client secret, along with other required details retrieved from Azure app registration configurations (see the example below).
-
Click Save and sign in.
-
Enter your Snowflake username and password. Click Sign in.
-
To provide consent to the database client, click Allow.
If the connection is successful, the following message appears in DataRobot:
Required parameters¶
In addition to the required fields listed below, you can learn about other available configuration options in the Snowflake documentation.
Required field | Description | Documentation |
---|---|---|
Required fields for data connection | ||
address |
A connection object that stores a secure connection URL to connect to Snowflake. Example: {account_name}.snowflakecomputing.com |
Snowflake documentation |
warehouse |
A unique identifier for your virtual warehouse. | Snowflake documentation |
db |
A unique identifier for your database. | Snowflake documentation |
Required fields for credentials | ||
Client ID | The public identifier for your application. | Snowflake documentation |
Client secret | A confidential identifier used to authenticate your application. | Snowflake documentation |
Snowflake account name | A unique identifier for your Snowflake account within an organization. | Snowflake documentation |
Snowflake External OAuth¶
Prerequisites¶
The following is required before connecting to Snowflake in DataRobot:
- A Snowflake account.
- External OAuth configured in Snowflake for Okta.
External OAuth with security integrations
If using Okta as the external identity provider (IdP), you must specify http://localhost/account/snowflake/snowflake_authz_return
as a Sign-in redirect URI when creating a new App integration in Okta.
- A Snowflake account.
- External OAuth configured in Snowflake for Microsoft Azure AD.
External OAuth with security integrations
If using Azure AD as the external identity provider (IdP), you must specify https://<datarobot_app_server>/account/snowflake/snowflake_authz_return
as a Redirect URI when registering both applications in Azure AD.
External IdP setup¶
Note
This section uses example configurations for setting up an external IdP. For information on setting up an external IdP based on your specific environment and requirements, see the documentation for Okta or Azure AD.
In the appropriate external IdP, create the Snowflake application(s):
Create a new App Integration in Okta:
- Go to Applications > Applications.
- Click Create App Integration.
- For the Sign-in method, select OIDC - OpenID Connect.
- For the Application type, select Web Application.
- Click Next.
-
Make sure the following options are selected:
- Client Credentials
- Authorization Code
- Refresh Token
- Require consent
-
Under LOGIN, add
http://localhost/account/snowflake/snowflake_authz_return
to the Sign-in redirect URIs. - This results in your
Client ID
andClient secret
.
Now, create a new Authorization Server:
-
Go to Security > API > Add Authorization Server.
- Set Audience to
https://<partner_name>.snowflakecomputing.com/
.<partner_name>
is thedatarobot_partner
for the current DataRobot Snowflake instance.
- Set Audience to
-
Go to Scopes > Add Scope.
- Set Name to
session:role:public
(refers to the Snowflake role). - For Check-in, add
Require user consent for this scope
andBlock services from requesting this scope
. - (Optional) Set the
offline_access
scope to require consent.
- Set Name to
-
Go to Access Policies > Add Rule and add the following rules:
- Add Check-in
Client Credentials
. - Add Check-in
Authorization Code
. - Add the client integration (created above) to the
Assigned to clients
field.
- Add Check-in
-
Go to Token and click Create token.
-
This results in the following:
Issuer
, for example,https://dev-11863425.okta.com/oauth2/aus15ca55wkdOxplJ5d7
.- Auth
Token
for programmatic access to the Okta API. - Auth server metadata JSON (found in Settings > Metadata URI).
Okta API calls
curl --location --request GET 'https://<OKTA_ACCOUNT>.okta.com/api/v1/users/me' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: SSWS <TOKEN>'
curl --location --request GET 'https://<OKTA_ACCOUNT>.okta.com/api/v1/users/<USER_ID>/clients/<CLIENT_ID>/grants' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: SSWS <TOKEN>'
curl --location --request DELETE 'https://<OKTA_ACCOUNT>.okta.com/api/v1/users/<USER_ID>/grants/<GRANT_ID>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: SSWS <TOKEN>'
Register an application for Snowflake Resource in Azure AD:
- Go to MS Azure > Azure AD > App registrations.
-
Click New registration.
- Under Name, enter Snowflake OAuth Resource.
- Under Supported account types, select Accounts in this organizational directory only.
- Under Redirect URI, select Web and enter
https://app.datarobot.com/account/snowflake/snowflake_authz_return
. - Click Register.
-
In the Overview section, copy the ClientID from the Application (client) ID field which will be
<OAUTH_CLIENT_ID>
value - Click on Certificates & secrets and then New client secret.
- Add a description of the secret.
- Click Add and copy the secret. Note that this value will not be available after this step. This will be
<OAUTH_CLIENT_SECRET>
value -
Expose the API.
- Click on the set link next to Application ID URI make sure it is a unique ID ( this does not need any change ). This will be the
value - Click on Add a scope to add a scope representing the Snowflake role
- Enter the scope name as
session:scope:public
- Click on the set link next to Application ID URI make sure it is a unique ID ( this does not need any change ). This will be the
Register an application for Snowflake Client App in Azure AD:
- Go to MS Azure > Azure AD > App registrations.
-
Click New registration.
- Under Name, enter Snowflake OAuth Client.
- Under Supported account types, select Accounts in this organizationl directory only.
- Under Redirect URI, select Web and enter
https://app.datarobot.com/account/snowflake/snowflake_authz_return
. - Click Register.
-
Go to
API Permission > Add Permission > My APIs > Snowflake Resource
and choose the scope created above for Snowflake Resource (session:scope:public
). -
For programmatic clients that will request an Access Token on behalf of a user, configure Delegated permissions for Applications as follows.
- Click on API Permissions.
- Click on Add Permission.
- Click on My APIs.
- Click on the Snowflake OAuth Resource that you created in Step 1: Configure the OAuth Resource in Azure AD.
- Click on the Delegated Permissions box.
- Check on the Permission related to the Scopes created in step 3
session:scope:public
- Click Add Permissions.
-
Collect additional information for Snowflake integration
- Click on App Registrations
- Click on the Snowflake OAuth Resource
- Click on Endpoints in the Overview interface
- Copy the OAuth 2.0 token endpoint (v2) which will be
<AZURE_AD_OAUTH_TOKEN_ENDPOINT>
value - Copy OpenID Connect metadata url from the endpoint overview and paste it on a new window
- Locate the "jwks_uri" parameter and copy its value which will be
<AZURE_AD_JWS_KEY_ENDPOINT>
value (e.g.,https://login.microsoftonline.com/6064c47c-80e4-4a2b-82ee-1fc5643b37a2/discovery/v2.0/keys
) - Copy Federation metadata document, open the URL in a new window. Locate the "entityID" which will be our
<AZURE_AD_ISSUER>
value (e.g.,https://sts.windows.net/6064c47c-80e4-4a2b-82ee-1fc5643b37a2/
)
-
This results in the following:
Client ID
andClient secret
copied from Snowflake OAuth Resource- Issuer URL copied from step 5
<AZURE_AD_ISSUER>
value <AZURE_AD_JWS_KEY_ENDPOINT>
value from Register an application for Snowflake Resource in Azure AD step 5<SNOWFLAKE_APPLICATION_ID_URI>
from Register an application for Snowflake Resource in Azure AD step 3
Related reading
Snowflake setup¶
Note
This section uses example configurations for setting up an external IdP in Snowflake. For information on setting up an external IdP in Snowflake based on your specific environment and requirements, see the Snowflake documentation.
In Snowflake, create an integration for the appropriate external IdP:
create security integration external_oauth_okta_2
type = external_oauth
enabled = true
external_oauth_type = okta
external_oauth_issuer = '<OKTA_ISSUER>'
external_oauth_jws_keys_url = '<JWKS_URI>'
external_oauth_audience_list = ('<AUDIENCE>')
external_oauth_token_user_mapping_claim = 'sub'
external_oauth_snowflake_user_mapping_attribute = 'login_name';
CREATE OR REPLACE USER <user_name>
LOGIN_NAME = '<okta_user_name>';
alter user <user_name> set DEFAULT_ROLE = 'PUBLIC';
Reference values:
OKTA_ISSUER
:https://dev-11863425.okta.com/oauth2/aus15ca55wkdOxplJ5d7
AUDIENCE
:https://hl91180.us-east-2.aws.snowflakecomputing.com/
JWKS_URI
:https://dev-11863425.okta.com/oauth2/aus15ca55wkdOxplJ5d7/v1/keys
(retrieved from Okta Auth server Metadata JSON)okta_user_name
(retrieved from Okta > Directory > People, select a user, and then go to Profile > Username/login )
Note
You must have the accountadmin
role, or a role with the global CREATE INTEGRATION
privilege to create the integration below.
create security integration external_oauth_azure_1
type = external_oauth
enabled = true
external_oauth_type = azure
external_oauth_issuer = 'https://sts.windows.net/6064c47c-80e4-4a2b-82ee-1fc5643b37a2/'
external_oauth_jws_keys_url = 'https://login.microsoftonline.com/6064c47c-80e4-4a2b-82ee-1fc5643b37a2/discovery/v2.0/keys'
external_oauth_audience_list = ('api://8aa2572f-c9e6-4e91-9eb1-dcd84c856dd2')
external_oauth_token_user_mapping_claim = 'upn'
external_oauth_any_role_mode = 'ENABLE'
external_oauth_snowflake_user_mapping_attribute = 'login_name';
Grant access on the integration to the public role:
grant USE_ANY_ROLE on integration external_oauth_azure_1 to PUBLIC;
Ensure that the LOGIN_NAME
of the user is the same as the Azure login. Verify using the following query in Snowflake:
DESC USER <SNOWFLAKE_LOGIN_NAME>
If the login names are different, Snowflake cannot validate the access token generated with Azure AD. In that case, use the command below to match Snowflake with Azure:
ALTER USER <SNOWFLAKE_LOGIN_NAME> SET LOGIN_NAME='<EMAIL_USED_FOR_AZURE_LOGIN>'
Set up the connection in DataRobot¶
When connecting with external OAuth parameters, you must create a new data connection.
To set up a Snowflake data connection using external OAuth:
-
Follow the instructions for creating a data connection and testing the connection.
-
After clicking Test Connection, select your OAuth provider from the dropdown—either Okta or Azure AD— and fill in the additional required fields.Then, click Save and sign in.
-
Enter your Okta or Azure AD username and password. Click Sign in.
-
To provide consent to the database client, click Allow.
If the connection is successful, the following message appears in DataRobot:
Required parameters¶
In addition to the required fields listed below, you can learn about other available configuration options in the Snowflake documentation.
Required field | Description | Documentation |
---|---|---|
Required fields for data connection | ||
address |
A connection object that stores a secure connection URL to connect to Snowflake. Example: {account_name}.snowflakecomputing.com |
Snowflake documentation |
warehouse |
A unique identifier for your virtual warehouse. | Snowflake documentation |
db |
A unique identifier for your database. | Snowflake documentation |
Required fields for credentials | ||
Client ID | The public identifier for your application. In the Okta Admin console, go to Applications > Applications > Your OpenID Connect web app > Sign On tab > Sign On Methods. In Azure AD, this is also known as the applicationID . |
Okta or Azure AD documentation |
Client secret | A confidential identifier used to authenticate your application. In the Okta Admin console, go to Applications > Applications > Your OpenID Connect web app > Sign On tab > Sign On Methods. In Azure AD, this is also known as the application secret . |
Okta or Azure AD documentation |
Snowflake account name | A unique identifier for your Snowflake account within an organization. | Snowflake documentation |
Issuer URL | A URL that uniquely identifies your SAML identity provider. "Issuer" refers to the Entity ID of your identity provider. Examples:
|
Okta or Azure AD documentation |
Scopes | Contains the name of your Snowflake role. Examples: Parameters for a Snowflake Analyst.
|
Snowflake documentation |
Reach out to your administrator for the appropriate values for these fields.
Caveats¶
By default, Snowflake preserves the case of alphabetic characters when storing and resolving double-quoted identifiers; however, if you override this default in Snowflake, double-quoted identifiers are stored and resolved as uppercase letters. Because DataRobot is a case-sensitive platform, it's important to preserve the original case of the letters.
To avoid potential issues related to case-sensitivity, go to your Snowflake data connection in DataRobot, add the QUOTED_IDENTIFIERS_IGNORE_CASE
parameter, and set the value to FALSE
. See the Snowflake documentation for more details.
Troubleshooting¶
Problem | Solution | Instructions |
---|---|---|
When attempting to execute an operation in DataRobot, the firewall requests that you clear the IP address each time. | Add all whitelisted IPs for DataRobot. | See Source IP addresses for whitelisting. If you've already added the whitelisted IPs, check the existing IPs for completeness. |
DataRobot returns the following message when testing external OAuth Snowflake connection with Azure AD: AADSTS700016: Application with identifier 'aa2572f-c9e6-4e91-9eb1-dcd84c856dd2' was not found in the directory 'Azure directory "datarobot" ("azuresupportdatarobot")'. This can happen if the application has not been installed by the administrator of the tenant or consented to by any user in the tenant. You may have sent your authentication request to the wrong tenant. |
Make sure scopes were created, granted, and assigned to the resource in Azure. | Refer to the Snowflake setup section for more details. |
DataRobot returns the following message when testing external OAuth after adding the data connection: JDBC connect failed for jdbc:snowflake://datarobot_partner.snowflakecomputing.com?CLIENT_TIMESTAMP_TYPE_MAPPING=TIMESTAMP_NTZ&db=SANDBOX&warehouse=DEMO_WH&application=DATAROBOT&CLIENT_METADATA_REQUEST_USE_CONNECTION_CTX=false. Original error: The role requested in the connection or the default role if none was requested in the connection (ACCOUNTADMIN ) is not listed in the Access Token or was filtered. Please specify another role, or contact your OAuth Authorization server administrator. |
Make sure the user who is establishing a connection with Azure has default role assigned. | The default role needs to be anything other than ACCOUNTADMIN , ORGADMIN , or SECURITYADMIN . If the session:scope is created with scope:role-any , the user can log in with any role other than the admin roles stated. |
DataRobot returns the following message when testing the connection: Invalid Request: The request tokens do not match the user context. Do not copy the user context values (cookies; form fields; headers) between different requests or user sessions; always maintain the ALL of the supplied values across a complete single user flow. Failure Reasons:[Token values do not match;] |
Make sure the login name of the user matches the login name in both Snowflake and Azure to map user and create access tokens. | You can alter the login name in Snowflake to match the username of Azure if it does not already match. |