Skip to content

Commit

Permalink
Update external-oauth.md (#6433)
Browse files Browse the repository at this point in the history
Add some Troubleshooting guidance for an external Oauth specific error

## What are you changing in this pull request and why?

Content added by @gunnava! Thanks so much!

## Checklist
- [ ] I have reviewed the [Content style
guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md)
so my content adheres to these guidelines.
- [ ] The topic I'm writing about is for specific dbt version(s) and I
have versioned it according to the [version a whole
page](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version)
and/or [version a block of
content](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#versioning-blocks-of-content)
guidelines.
- [ ] I have added checklist item(s) to this list for anything anything
that needs to happen before this PR is merged, such as "needs technical
review" or "change base branch."
- [ ] The content in this PR requires a dbt release note, so I added one
to the [release notes
page](https://docs.getdbt.com/docs/dbt-versions/dbt-cloud-release-notes).
<!--
PRE-RELEASE VERSION OF dbt (if so, uncomment):
- [ ] Add a note to the prerelease version [Migration
Guide](https://github.com/dbt-labs/docs.getdbt.com/tree/current/website/docs/docs/dbt-versions/core-upgrade)
-->
<!-- 
ADDING OR REMOVING PAGES (if so, uncomment):
- [ ] Add/remove page in `website/sidebars.js`
- [ ] Provide a unique filename for new pages
- [ ] Add an entry for deleted pages in `website/vercel.json`
- [ ] Run link testing locally with `npm run build` to update the links
that point to deleted pages
-->

---------

Co-authored-by: gunnava <[email protected]>
Co-authored-by: Mirna Wong <[email protected]>
Co-authored-by: nataliefiann <[email protected]>
  • Loading branch information
4 people authored Nov 12, 2024
1 parent 7689772 commit 46b3ca9
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 0 deletions.
4 changes: 4 additions & 0 deletions website/docs/docs/cloud/manage-access/external-oauth.md
Original file line number Diff line number Diff line change
Expand Up @@ -267,3 +267,7 @@ app in Entra ID, click **Endpoints** and open the **Federation metadata document
6. `Application ID URI`: Copy the `Application ID URI` field from the resource server’s Overview screen.

</Expandable>

## FAQs

<FAQ path="Troubleshooting/failed-snowflake-oauth-connection" />
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: Receiving a `Failed to connect to DB` error when connecting to Snowflake
description: "Edit your OAuth Security integration when you see error"
sidebar_label: 'Receiving `Failed to connect to database` error'
---

1. If you see this error:

```shell

Failed to connect to DB: xxxxxxx.snowflakecomputing.com:443. The role requested in the connection, or the default role if none was requested in the connection ('xxxxx'), is not listed in the Access Token or was filtered.
Please specify another role, or contact your OAuth Authorization server administrator.

```
2. Edit your OAuth Security integration and explicitly specify this scope mapping attribute:
```sql
ALTER INTEGRATION <my_int_name> SET EXTERNAL_OAUTH_SCOPE_MAPPING_ATTRIBUTE = 'scp';
```
You can read more about this error in [Snowflake's documentation](https://community.snowflake.com/s/article/external-custom-oauth-error-the-role-requested-in-the-connection-is-not-listed-in-the-access-token).

0 comments on commit 46b3ca9

Please sign in to comment.