Okta SCIM Integration with Snowflake¶
This guide provides the steps required to configure Provisioning in Okta for Snowflake, and includes the following sections:
User and Role Administration is supported for the Snowflake application.
This enables Okta to:
Manage the user lifecycle (i.e. create, update, and delete) in Snowflake.
Manage the role lifecycle (i.e. create, update, and delete) in Snowflake.
Manage user to role assignments in Snowflake.
The following provisioning features are supported:
- Push New Users
New users created through OKTA will also be created in Snowflake.
- Push Profile Updates
Updates made to the user’s profile through OKTA will be pushed to Snowflake.
- Push User Deactivation
Deactivating the user or disabling the user’s access to Snowflake through OKTA will deactivate the user in Snowflake.
For Snowflake, deactivating a user means setting the
isActiveattribute for the user to false.
- Reactivate Users
User accounts can be reactivated Snowflake.
- Sync Password
User password can be pushed from Okta into Snowflake, if required.
The default setting is to create a random password for users giving the user an attribute setting of
has_Password=true. Without a password, users must access Snowflake through Okta SSO. To prevent a password being generated for users, turn this setting off before provisioning users as follows:
Under Sync Password, uncheck the setting Generate a new random password whenever the user’s Okta password changes.
Save the change.
Enabling this setting in Okta creates a password for the user to access Snowflake. This could result in a pathway for users to access Snowflake without SSO.
- Push Groups
The Push Groups feature creates roles in Snowflake and facilitates role management. The roles created in Snowflake using Okta Push Groups have the same names in Okta and Snowflake. Always create roles in Okta first and use Push Groups to update Snowflake to ensure Okta and Snowflake can synchronize. Okta and the OKTA_PROVISIONER custom role in Snowflake cannot manage manually created roles in Snowflake. Push Groups do not create users in Snowflake.
Okta can create users in Snowflake if the Snowflake application in Okta is assigned to a user in Okta.
For more information, see Assign an application to a user.
The following user attributes are supported:
SCIM User Attribute
Snowflake User Attribute
name and login_name
If your Snowflake account was created with underscores in the account name (e.g.
my_account), you can access your Snowflake account with the account name having underscores or hyphens (e.g.
my-account). If you reuse the hyphenated account name for both Okta SAML SSO and Okta SCIM, then account names with underscores are not supported. Therefore, use the hyphenated account name to configure SCIM.
Existing Snowflake roles cannot be brought under Okta’s management through transfer of ownership. Only new roles can be created through Okta.
Existing Snowflake users can be brought under Okta’s management through a transfer of ownership. For more information, see Troubleshooting Tips (in this topic).
Snowflake supports a maximum of 500 concurrent requests per account per SCIM endpoint (e.g. the
/Groupsendpoint). After your account exceeds this threshold, Snowflake returns a
429HTTP status code (i.e. too many requests). Note that this request limit usually only occurs during the initial provisioning when relatively large numbers of requests (i.e. more than 10 thousand) occur to provision users or groups.
Okta’s Enhanced Group Push and Push Now features.
defaultWarehouseattributes are unmapped as they are optional. To map these attributes in Okta, use profiles, expressions, or set a default value for all users. For more information, see Manage profiles (in Okta).
If you are using AWS PrivateLink or Azure Private Link to access Snowflake, ensure that you are not entering either of these URLs in the integration settings. Enter the public endpoint (i.e. without
.privatelink), and ensure that the network policy allows access from the Okta IP address listed here, otherwise you cannot use this integration.
Okta does not currently support importing Active Directory nested groups. Therefore, if your Okta integration uses nested groups in AD, you cannot use the Snowflake Okta SCIM integration to provision or manage nested groups in Snowflake. Please contact Okta and Microsoft to request the support of nested groups.
Before you configure provisioning for Snowflake, make sure you have configured the General Settings and any Sign-On Options for the Snowflake application in Okta.
Once the above steps are complete, click Next in Okta to take you back to the Provisioning tab.
The configuration process requires completing steps in Snowflake and in Okta.
The Snowflake configuration process creates a SCIM security integration to allow users and roles created in Okta to be owned by the OKTA_PROVISIONER SCIM role in Snowflake and creates an access token to use in SCIM API requests. The access token is valid for six months. Upon expiration, create a new access token manually using SYSTEM$GENERATE_SCIM_ACCESS_TOKEN as shown below.
To invalidate an existing access token for a SCIM integration, execute a DROP INTEGRATION statement.
Execute the following SQL statements in your preferred Snowflake client. Each of the SQL statements is explained below.
use role accountadmin; create or replace role okta_provisioner; grant create user on account to role okta_provisioner; grant create role on account to role okta_provisioner; grant role okta_provisioner to role accountadmin; create or replace security integration okta_provisioning type = scim scim_client = 'okta' run_as_role = 'OKTA_PROVISIONER'; select system$generate_scim_access_token('OKTA_PROVISIONING');
The example SQL statements use the ACCOUNTADMIN system role and the OKTA_PROVISIONER custom role is granted to the ACCOUNTADMIN role.
It is possible not to use the ACCOUNTADMIN role in favor of a less-privileged role. Using a less-privileged role can help to address compliance concerns relating to least-privileged access, however, using a less-privileged role can result in unexpected errors during the SCIM configuration and management process.
These errors could be the result of the less-privileged role not having sufficient rights to manage all of the roles through SCIM due to how the roles are created and the resultant role hierarchy. Therefore, in an effort to avoid errors in the configuration and management processes, choose one of the following options:
Use the ACCOUNTADMIN role as shown in the example SQL statements.
Use a role with the global MANAGE GRANTS privilege.
If neither of these first two options are desirable, use a custom role that has the OWNERSHIP privilege on all of the roles that will be managed using SCIM.
Use the ACCOUNTADMIN role.
use role accountadmin;
Create the custom role OKTA_PROVISIONER. All users and roles in Snowflake created by Okta will be owned by the scoped down OKTA_PROVISIONER role.
create or replace role okta_provisioner; grant create user on account to role okta_provisioner; grant create role on account to role okta_provisioner;
Let the ACCOUNTADMIN role create the security integration using the OKTA_PROVISIONER custom role. For more information, see CREATE SECURITY INTEGRATION.
grant role okta_provisioner to role accountadmin; create or replace security integration okta_provisioning type = scim scim_client = 'okta' run_as_role = 'OKTA_PROVISIONER';
Create and copy the authorization token to the clipboard and store securely for later use. Use this token for each SCIM REST API request and place it in the request header. The access token expires after six months and a new access token can be generated with this statement.
All users and roles in Snowflake created by Okta will be owned by the scoped down
If you want to manage existing Snowflake users through Okta, complete the following steps:
Transfer ownership of existing users to the okta_provisioner role.
use role accountadmin; grant ownership on user <user_name> to role okta_provisioner;
login_nameproperty is set for existing users which should already be set if these existing Snowflake users are using Okta SSO.
Be advised that the name for existing users brought under Okta’s management will be updated to match with Okta’s username. Inform your users about this change as they may be using the name to connect to Snowflake from other integration (i.e. Tableau).
In Okta, access the Snowflake application and complete the following steps.
In Settings, select Integration from the left hand menu and then check the Enable API Integration box.
For API Token, enter the value generated above from the clipboard. Click Test API Credentials button, and, if successful, save the configuration.
Select To App from the left hand menu.
Select the Provisioning Features you want to enable.
Verify the Attribute Mappings. The
defaultWarehouseattributes are unmapped as they are optional. If there’s a need, you can map them using Okta profile or expression or set the same value for all users.
You can now assign users to the Snowflake application (if needed) and finish the application setup.
Okta supports an attribute called
snowflakeUserName which maps to the
name field of the Snowflake user.
If you want the
login_name fields for the Snowflake user to have different values, follow this procedure.
Contact Snowflake support to enable separate mapping for your account.
In Okta, access the Snowflake application and navigate to Provisioning > Attribute Mappings > Edit Mappings.
Search for the attribute
If the attribute is not found, the Snowflake application was created prior to this attribute being available. Recreate the Snowflake application with the mappings shown below or add the attribute manually as follows:
Click Add Attribute.
Set the following values for each of the listed fields in the table.
Maps to the
namefield of the user in Snowflake.
Enabling Snowflake-initiated SSO¶
The SCIM provisioning process does not automatically enable single sign-on (SSO).
To use SSO after the SCIM provisioning process is complete, enable Snowflake-initiated SSO.
Managing SCIM Network Policies¶
The SCIM network policy has its own setting so that the SCIM provider can be specifically allowed to provision users and groups without adding these IP addresses for normal user access.
Setting up a network policy specific to the SCIM integration allows SCIM to be distinct from other network policies that may apply to the Snowflake account. The SCIM network policy does not affect other network policies on the account nor do other account network polices affect the SCIM network policy. Therefore, the SCIM network policy allows the Snowflake SCIM integration to provision users and groups as intended.
After creating the SCIM security integration, create the SCIM network policy using this command:
alter security integration okta_provisioning set network_policy = <scim_network_policy>;
To unset the SCIM network policy, use this command:
alter security integration okta_provisioning unset <scim_network_policy>;
Specifies the name of the Okta SCIM security integration.
Specifies the Okta SCIM network policy in Snowflake.
Transferring Ownership. If the user update fails, check the ownership of the user in Snowflake. If it’s not owned by the
okta_provisionerrole (or the role set in the
run_as_roleparameter when creating the security integration in Snowflake), then the update will fail. Transfer the ownership by running the following SQL statement in Snowflake and try again.
grant ownership on user <username> to role OKTA_PROVISIONER;
login_nameproperty is set for existing users which should already be set if these existing Snowflake users are using Okta SSO.
To verify that Okta is sending updates to Snowflake, check the log events in Okta for the Snowflake application and the SCIM audit logs in Snowflake to ensure Snowflake is receiving updates from Okta. Use the following to query the Snowflake SCIM audit logs.
use role accountadmin; use database demo_db; use schema information_schema; select * from table(rest_event_history('scim')); select * from table(rest_event_history( 'scim', dateadd('minutes',-5,current_timestamp()), current_timestamp(), 200)) order by event_timestamp;
It is possible that an authentication error may occur during the provisioning process. One possible error message is as follows:
Error authenticating: Forbidden. Errors reported by remote server: Invalid JSON: Unexpected character ('<' (code 60)): expected a valid value (number, String, array, object, 'true', 'false' or 'null') at [Source: java.io.StringReader@4c76ba04; line: 1, column: 2]
If this error message or other authentication error messages occur, try this troubleshooting procedure:
In Okta, remove the current Snowflake application and create a new Snowflake application.
In Snowflake, create a new SCIM security integration and generate a new access token.
Copy the new token by clicking Copy.
In Okta, paste and verify the new access token as described in how to configure Okta as a SCIM identity provider.
Provision users and roles from Okta to Snowflake using the new Snowflake application in Okta.