Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Snowflake and Core OAuth #6435

Merged
merged 6 commits into from
Nov 7, 2024
Merged
28 changes: 26 additions & 2 deletions website/docs/docs/core/connect-data-platform/snowflake-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@

</File>

### SSO Authentication
### SSO authentication

To use SSO authentication for Snowflake, omit a `password` and instead supply an `authenticator` config to your target.
`authenticator` can be one of 'externalbrowser' or a valid Okta URL.
Expand Down Expand Up @@ -332,7 +332,7 @@

</File>

### SSO Authentication
### SSO authentication

To use SSO authentication for Snowflake, omit a `password` and instead supply an `authenticator` config to your target.
`authenticator` can be one of 'externalbrowser' or a valid Okta URL.
Expand Down Expand Up @@ -421,6 +421,30 @@

Refer to the [Snowflake docs](https://docs.snowflake.com/en/sql-reference/parameters.html#label-allow-id-token) for info on how to enable this feature in your account.

### OAuth authorization

Check warning on line 424 in website/docs/docs/core/connect-data-platform/snowflake-setup.md

View workflow job for this annotation

GitHub Actions / vale

[vale] website/docs/docs/core/connect-data-platform/snowflake-setup.md#L424

[custom.SentenceCaseHeaders] 'OAuth authorization' should use sentence-style capitalization. Try '' instead.
Raw output
{"message": "[custom.SentenceCaseHeaders] 'OAuth authorization' should use sentence-style capitalization. Try '' instead.", "location": {"path": "website/docs/docs/core/connect-data-platform/snowflake-setup.md", "range": {"start": {"line": 424, "column": 5}}}, "severity": "WARNING"}

See the Snowflake [docs](https://docs.snowflake.com/en/user-guide/oauth-snowflake-overview) for information about configuring OAuth. Your Snowflake admin needs to generate an [OAuth token](https://community.snowflake.com/s/article/HOW-TO-OAUTH-TOKEN-GENERATION-USING-SNOWFLAKE-CUSTOM-OAUTH) for your configuration to work.
matthewshaver marked this conversation as resolved.
Show resolved Hide resolved

The OAUTH_REDIRECT_URI you provide in Snowflake is `http://localhost:PORT_NUMBER`. For example, `http://localhost:8080`.

Check warning on line 428 in website/docs/docs/core/connect-data-platform/snowflake-setup.md

View workflow job for this annotation

GitHub Actions / vale

[vale] website/docs/docs/core/connect-data-platform/snowflake-setup.md#L428

[custom.Typos] Oops there's a typo -- did you really mean 'OAUTH_REDIRECT_URI'?
Raw output
{"message": "[custom.Typos] Oops there's a typo -- did you really mean 'OAUTH_REDIRECT_URI'? ", "location": {"path": "website/docs/docs/core/connect-data-platform/snowflake-setup.md", "range": {"start": {"line": 428, "column": 5}}}, "severity": "WARNING"}
matthewshaver marked this conversation as resolved.
Show resolved Hide resolved

Once your Snowflake admin has configured OAuth, add the following to your `profiles.yml` file:
matthewshaver marked this conversation as resolved.
Show resolved Hide resolved

```yaml

my-snowflake-db:
target: dev
outputs:
dev:
type: snowflake
account: [account id]

# The following fields are retrieved from the Snowflake configuration
authenticator: oauth
oauth_client_id: [OAuth client id]
oauth_client_secret: [OAuth client secret]
token: [OAuth refresh token]
```

## Configurations

The "base" configs for Snowflake targets are shown below. Note that you should also specify auth-related configs specific to the authentication method you are using as described above.
Expand Down
Loading