# Snowflake (prebuilt connector)

## Description

**Snowflake** provides a single platform for data warehousing, data lakes, data engineering, etc., with secure sharing and consumption of real-time / shared data..

## API documentation

**Snowflake's** API documentation (used to build this connector) can be found via the link below:

{% embed url="<https://docs.snowflake.com/en/developer-guide/sql-api/index>" %}

## Authentication&#x20;

When adding connector instances for **Snowflake**, the following authentication methods are supported:

* [OAuth 2 (authorisation code)](#oauth-2-authorisation-code)

### OAuth 2 (authorisation code)

When a user chooses to [add a connector instance](https://doc.wearepatchworks.com/product-documentation/~/changes/J8IbZkP6ASUZu2oBhGi2/connectors-and-instances/working-with-instances/adding-an-instance) using **OAuth 2 (authorisation code)** authentication, the credentials below are prompted:

<table><thead><tr><th width="210">Credential</th><th width="174" data-type="checkbox">Required?</th><th>Notes</th></tr></thead><tbody><tr><td><code>base url</code></td><td>true</td><td>The base URL for your Snowflake instance.</td></tr><tr><td><code>state length</code></td><td>true</td><td>This field can be left blank. </td></tr><tr><td><code>scope</code></td><td>true</td><td>This field can be left blank but if required, available  options are detailed in <a href="https://docs.snowflake.com/en/user-guide/oauth-custom#scope">Snowflake's API documentation</a>.</td></tr><tr><td><code>client id</code></td><td>true</td><td>See <a href="https://community.snowflake.com/s/article/HOW-TO-OAUTH-TOKEN-GENERATION-USING-SNOWFLAKE-CUSTOM-OAUTH">this Snowflake article</a> for information about generating your client credentials.</td></tr><tr><td><code>client secret</code></td><td>true</td><td>See <a href="https://community.snowflake.com/s/article/HOW-TO-OAUTH-TOKEN-GENERATION-USING-SNOWFLAKE-CUSTOM-OAUTH">this Snowflake article</a> for information about generating your client credentials.</td></tr><tr><td><code>response authentication token key</code></td><td>true</td><td>Leave set to <code>access_token</code></td></tr><tr><td><code>grant type</code></td><td>true</td><td>Leave set to <code>authorization_code</code></td></tr><tr><td><code>response type key</code></td><td>true</td><td>Leave set to <code>code</code></td></tr><tr><td><code>refresh grant type</code></td><td>true</td><td>Leave set to <code>refresh_token</code></td></tr><tr><td><code>response refresh token key</code></td><td>true</td><td><code>refresh_token</code></td></tr></tbody></table>