Configure PingFederate for External OAuth¶

Configure PingFederate¶

1. Navigate to the PingFederate Server downloads page and either download or upgrade your PingFederate instance based on your operating system (https://www.pingidentity.com/en/resources/downloads/pingfederate.html).

2. Use the PingFederate installation guide for your operating system. After installation, access PingFederate.

3. Create the OAuth Scopes by navigating to the Exclusive Scopes interface in the OAuth Server panel.

4. To add a Snowflake Role as a scope, add the role to the Scope Value. The Snowflake role must have the session:role: prefix (e.g. for the Snowflake Analyst role, enter session:role:analyst).

5. Enter a description for the scope in the Scope Description box and click Add.

6. Navigate to the OAuth Server tab and create a new client. Verify the following values.

   Field	Value
   NAME	A friendly name for the PingFederate OAuth Authorization server
   DESCRIPTION	A friendly description for the PingFederate OAuth Authorization Server
   CLIENT AUTHENTICATION	CLIENT SECRET
   EXCLUSIVE SCOPES	Select the Scopes (i.e. Snowflake Roles)
   ALLOWED GRANT TYPES	Choose Refresh Token and Resource Owner Password Credentials
   DEFAULT ACCESS TOKEN MANAGER	JSON Web Tokens

7. Navigate to the Security tab and export the certificate. Extract the public key from the certificate for use in the following steps.

8. Navigate to the Instance Configuration tab under the OAuth Server tab and Access Token Management | Create Access Token Management Instance, and then:

   • Update the ISSUER CLAIM VALUE to the unique identifier referencing this OAuth Authorization Server.

   • Update the AUDIENCE CLAIM VALUE to your Snowflake account URL (e.g. https://<account_identifier>.snowflakecomputing.cn). For a list of possible URL formats, see Connecting with a URL.

9. Download the PingFederate OAuth Playground add on from the Developer Tools (https://www.pingidentity.com/en/resources/downloads/pingfederate.html) section. This client performs API requests.

10. Install the OAuth Playground (https://www.pingidentity.com/content/dam/developer/downloads/Software/OAuth%20Grant%20Types%20using%20the%20OAuth%20PlayGround.pdf).

Create a security integration in Snowflake¶

This step creates a security integration in Snowflake to ensure that Snowflake can communicate with PingIdentity securely, validate the tokens from PingIdentity, and provide the appropriate Snowflake data access to users based on the user role associated with the OAuth token.

Execute the following statement in either the Snowflake web interface or in SnowSQL.

Note that the value for external_oauth_issuer must be the unique identifier set in Step 1.8. For example, if the unique identifier value is 27f10cde-a964-4499-a88c-0c598883e5ad, replace <unique_id> with '27f10cde-a964-4499-a88c-0c598883e5ad'. The unique identifier must be in single (i.e. vertical) quotes.

Choose the security integration that best addresses your use case and configuration needs. For more information, see CREATE SECURITY INTEGRATION.

Create a security integration for PingFederate

create or replace security integration external_oauth_pf_1
    type = external_oauth
    enabled = true
    external_oauth_type = ping_federate
    external_oauth_rsa_public_key = '<BASE64_PUBLIC_KEY>'
    external_oauth_issuer = '<unique_id>'
    external_oauth_token_user_mapping_claim = 'username'
    external_oauth_snowflake_user_mapping_attribute = 'login_name';

Copy

This security integration uses the external_oauth_rsa_public_key parameter. Snowflake uses the public key value to verify the Signature on JWT Access Token.

Create a security integration with audiences

The external_oauth_audience_list parameter of the security integration must match the Audience Claim Value that you specified while configuring PingFederate.

create security integration external_oauth_pf_2
    type = external_oauth
    enabled=true
    external_oauth_type = ping_federate
    external_oauth_issuer = '<ISSUER>'
    external_oauth_rsa_public_key = '<BASE64_PUBLIC_KEY>'
    external_oauth_audience_list = ('<snowflake_account_url>')
    external_oauth_token_user_mapping_claim = 'username'
    external_oauth_snowflake_user_mapping_attribute = 'login_name';

Copy

This security integration uses the external_oauth_rsa_public_key parameter. Snowflake uses the public key value to verify the Signature on JWT Access Token.

Modifying Your External OAuth Security Integration¶

You can update your External OAuth security integration by executing an ALTER statement on the security integration.

For more information, see ALTER SECURITY INTEGRATION (External OAuth).

Using ANY role with External OAuth¶

In the configuration step to create a security integration in Snowflake, the OAuth access token includes the scope definition. Therefore, at runtime, using the External OAuth security integration allows neither the OAuth client nor the user to use an undefined role in the OAuth access token.

After validating the access token and creating a session, the ANY role can allow the OAuth client and user to decide its role. If necessary, the client or the user can switch to a role that is different that the role defined in the OAuth access token.

To configure ANY role, define the scope as SESSION:ROLE-ANY and configure the security integration with the external_oauth_any_role_mode parameter. This parameter can have three possible string values:

• DISABLE does not allow the OAuth client or user to switch roles (i.e. use role <role>;). Default.

• ENABLE allows the OAuth client or user to switch roles.

• ENABLE_FOR_PRIVILEGE allows the OAuth client or user to switch roles only for a client or user with the USE_ANY_ROLE privilege. This privilege can be granted and revoked to one or more roles available to the user. For example:

  grant USE_ANY_ROLE on integration external_oauth_1 to role1;
  

  Copy

  revoke USE_ANY_ROLE on integration external_oauth_1 from role1;
  

  Copy

Define the security integration as follows:

create security integration external_oauth_1
    type = external_oauth
    enabled = true
    external_oauth_any_role_mode = 'ENABLE'
    ...

Using secondary roles with External OAuth¶

The desired scope for the primary role is passed in the external token: either the default role for the user (session:role-any) or a specific role that was granted to the user (session:role:<role_name>).

By default, Snowflake does not activate the default secondary roles for a user (i.e. the DEFAULT_SECONDARY_ROLES) user in the session.

To activate the default secondary roles for a user in a session and allow executing the USE SECONDARY ROLES command while using External OAuth, complete the following steps:

1. Configure the security integration for the connection. Set the EXTERNAL_OAUTH_ANY_ROLE_MODE parameter value to either ENABLE or ENABLE_FOR_PRIVILEGE when you create the security integration (using CREATE SECURITY INTEGRATION) or later (using ALTER SECURITY INTEGRATION).

2. Configure the authorization server to pass the static value of session:role-any in the scope attribute of the token. For more information about the scope parameter, see External OAuth overview.

Using network policies with External OAuth¶

Currently, network policies cannot be added to your External OAuth security integration. However, you can still implement network policies that apply broadly to the entire Snowflake account.

If your use case requires a network policy that is specific to the OAuth security integration, use Snowflake OAuth. This approach allows the Snowflake OAuth network policy to be distinct from other network policies that may apply to the Snowflake account.

For more information, see Network policies.

Using replication with External OAuth¶

Snowflake supports replication and failover/failback of the External OAuth security integration from a source account to a target account.

For details, see Replication of security integrations & network policies across multiple accounts.