search

tableau / connector-plugin-sdk

SDK for Developing Tableau Connector Plugins
https://tableau.github.io/connector-plugin-sdk/
MIT License
105 stars 107 forks source link

[FEATURE] allow external OAuth config files without having to embed one #1108

Open xsgao-github opened 1 year ago

xsgao-github commented 1 year ago

Is your feature request related to a problem? Please describe.

Quote from https://tableau.github.io/connector-plugin-sdk/docs/oauth:

However in both cases, at least one embedded config is still required.

For Starburst Enterprise and Galaxy, users define which IDP to use for OAuth. So we can't embed a generic OAuth config in our connector, and have to put a dummy one labeled as ..._template. This is not user-friendly.

image

Describe the solution you'd like Remove the restriction at least one embedded config is still required so we can build a generic connector without embed OAuth config.

Describe alternatives you've considered None.

About You Name: Song Gao Company: Starburst Data

carlossc commented 1 year ago

At Denodo, we are also interested on this.

About You: Name: Carlos Santos Canelles Company: Denodo Technologies

carlossc commented 1 year ago

@xsgao-github , we are going to include a default OAuth configuration for Azure AD so at least there is something there that can be useful.

rosswbrown commented 1 year ago

Thanks for your feedback. We are tracking this in our backlog as a potential improvement for a future release. This issue will be left open and notified if there are any changes.

Luke-Shao commented 4 days ago

Hi, does anyone have any update on this feature? Any target release date? Thanks. @carlossc @rosswbrown

carlossc commented 4 days ago

@Luke-Shao I work for Denodo; not Tableau. I am not aware that Tableau implemented this.

pvanderknyff commented 13 hours ago

This feature was added in the 2024.1 release, but due to an oversight on my part it has not been documented yet. Wrote up a story to document this feature, but in the meantime you can create an OAuth-enabled connector without an embedded config by setting the oauth-config element in the manifest to null_config. Until we get a sample up you can use this packager unit test file as a guide:

https://github.com/tableau/connector-plugin-sdk/blob/ae18eb0d7151e345f0d3e77e67e83ca27f169a8a/connector-packager/tests/test_resources/null_oauth_config/manifest.xml#L19

If the customer has not set up BYOIDP, and they try and choose OAuth, they'll be told that OAuth is not set up and the sign in button will be disabled.

Will keep this issue open until the official documentation is merged.