Use OAuth 2.0 in Connections to Cloud Data Stores

Your software provides a security methodology called Trusted Access to authenticate your end users when they use your embedded components.

You can leverage existing authorization rules of BigQuery and Snowflake data sources by enabling OAuth 2.0 for these connectors in Self-Service Analytics. Users access the connected data stores, using their personalized credentials, and receive access to the data following the security rules of your data source.

Feature Support

Use OAuth to connect to these supported data sources:

• Connect to BigQuery
• Connect to Snowflake

To avoid frequent authentication requests for users, Self-Service Analytics operates with long-lived tokens and preemptively refreshes the tokens when they are close to expiration.

Scheduled source refresh is not available when you use OAuth 2.0 authentication.

OAuth 2.0 Setup - BigQuery

To create a BigQuery connection use one of the available authentication methods:

• Key authentication flow requires a security key to be generated at BigQuery and placed to the Self-Service Analytics instance;
• OAuth 2.0 requires providing OAuth client_id and client_secrets generated for a user that will serve for data retrieval, such as an integration user. Users are asked to authenticate via a separate authentication form. Users provide their individual credentials when accessing the data retrieved using this connection.

If both authentication methods are selected, connection via OAuth will have higher priority over key authentication except for the scheduled overrides setup.

	Authentication Flow
Key Path	Key Authentication	Absolute path to the key authentication file obtained from BigQuery and placed to Self-Service Analytics instance.
Public Project Ids		List of public project IDs that will be queried for the data.
OAuth 2.0 Enabled	OAuth 2.0	TRUE/FALSE
Project Id		Billing project ID that will be queried for the data. Optional if keys authentication is used. Mandatory if OAuth 2.0 connection is enabled.
OAuth 2.0 Client Id		client_id: Obtain from BigQuery. See https://cloud.google.com/bigquery/docs/authentication/end-user-installed.
OAuth 2.0 Client Secrets		client_secrets: Obtain from BigQuery. See https://cloud.google.com/bigquery/docs/authentication/end-user-installed.

Scheduled Override Options

To maintain Self-Service Analytics’s ability to perform scheduled operations such as scheduled dashboard reports, alerts notifications, and more when using OAuth 2.0 authentication flow, you can setup scheduled overrides with key authentication method by providing a key path.

Additional OAuth 2.0 parameters available for override, however, already have prepopulated BigQuery values and do not require manual editing:

• OAUTH2.AUTHORIZATION_URI
• OAUTH2.TOKEN_URI
• OAUTH2.SCOPES

Scheduled source refresh is not available when you use OAuth 2.0 authentication.

To avoid frequent authentication requests for users, Self-Service Analytics operates with long-lived tokens and preemptively refreshes the tokens when they are close to expiration.

Users’ OAuth sessions are terminated when the OAuth token is revoked, if the connection is deleted, or connection details are modified.

OAuth 2.0 Setup - Snowflake

To create a Snowflake connection use one of the available authentication methods:

• Basic authentication via username and password
• OAuth 2.0

If connecting using basic authentication, provide:

• The name of the connection.

• The JDBC URL.

• Each Snowflake connection you use must be associated with a database.

  • The database can be the one specified in the JDBC URL, or
  • The default database of the connecting user (if no database is specified in the JDBC URL).

• The username and password. Only simple username and password authentication is supported.

For connecting via OAuth 2.0, fill in the specific parameters:

JDBC URL
OAuth 2.0 Enabled	TRUE/FALSE
OAuth 2.0 Authorization URI	Obtain OAuth 2.0 connection parameters from your Snowflake instance for connection.
OAuth 2.0 Token URI
OAuth 2.0 Client Id
OAuth 2.0 Client Secret

Scheduled source refresh is not available when you use OAuth 2.0 authentication.

If you do not want to expose OAuth 2.0 connection options to your customers, disable OAuth-related connection parameters at the connector level as a member of the Supervisors group.