Skip to content

Commit 318c334

Browse files
committed
scal-203358
Signed-off-by: Naomi Lattanzi <naomi.lattanzi@thoughtspot.com>
1 parent 62a4bb5 commit 318c334

3 files changed

+28
-22
lines changed

cloud/modules/ROOT/pages/connections-databricks-oauth-aad.adoc

-2
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,6 @@ Databricks SQL warehouses are configured with OAuth 2.0 authentication. ThoughtS
1414

1515
NOTE: For OAuth, we recommend checking the {connection} link:https://docs.databricks.com/en/administration-guide/users-groups/single-sign-on/index.html[documentation] to confirm any IDP support and their details. This article documents only the most frequently set-up IDP.
1616

17-
IMPORTANT: Each ThoughtSpot instance requires a unique {connection} security integration.
18-
Each user in {connection} must have a default warehouse and default role.
1917

2018
== Part 1: Create an application in AAD
2119

cloud/modules/ROOT/pages/connections-databricks-oauth.adoc

-2
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,6 @@ The configuration details on the ThoughtSpot connection form should be derived f
1919

2020
NOTE: For OAuth, we recommend checking the {connection} link:https://docs.databricks.com/en/administration-guide/users-groups/single-sign-on/index.html[documentation] to confirm any IDP support and their details.
2121

22-
IMPORTANT: Each ThoughtSpot instance requires a unique {connection} security integration.
23-
Each user in {connection} must have a default warehouse and default role.
2422

2523
[#step-1]
2624
== Step 1: Registering an OAuth application from Databricks Account Console

cloud/modules/ROOT/pages/connections-databricks-reference.adoc

+28-18
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,20 @@ If your {connection} is hosted on Microsoft Azure, see <<databricks-azure,{conne
1616
Connection name:: Enter a new {connection} connection name.
1717
Connection description:: Provide a short description of the connection. _(Optional)_
1818
[#databricks-reference-host]
19-
Host:: Enter the {connection} server host name without the protocol. You can find this in the connection details of your SQL warehouse.
19+
Host:: Enter the {connection} server host name without the protocol. You can find this in the connection details of your SQL warehouse. For more information, see link:https://docs.databricks.com/en/integrations/compute-details.html[Get connection details for a Databricks compute resource].
2020
Example;; *example.cloud.databricks.com*
21-
HTTP Path:: Enter the {connection} HTTP path. You can find this in the connection details of your SQL warehouse.
22-
(Service account only) User:: Email address associated with your {connection} account.
23-
(Service account only) Password:: Specify the password of the {connection} account. You can also use your '`personal access token`' generated in {connection}. For more information, see https://docs.microsoft.com/en-us/azure/databricks/dev-tools/api/latest/authentication#--generate-a-personal-access-token[Generate a personal access token^].
24-
(OAuth and OAuth with PKCE only) OAuth Client ID:: Specify the OAuth client ID.
25-
(OAuth and OAuth with PKCE only) OAuth Client Secret:: Specify the OAuth client secret.
26-
(OAuth and OAuth with PKCE only) Scope:: Specify the scope.
27-
(OAuth and OAuth with PKCE only) Auth Url:: Specify the auth url.
28-
(OAuth and OAuth with PKCE only) Access token Url:: Specify the access token url.
21+
HTTP Path:: Enter the {connection} HTTP path. You can find this in the connection details of your SQL warehouse. For more information, see link:https://community.thoughtspot.com/customers/s/article/Where-is-the-http-path-for-my-Databricks-compute-resource[Where is the http path for my Databricks compute resource] or link:https://docs.databricks.com/en/integrations/compute-details.html[Get connection details for a Databricks compute resource].
22+
Service account::
23+
User::: Email address associated with your {connection} account. Username and password authentication is known as Databricks basic authentication; it is possible only when single sign-on is disabled.
24+
+
25+
When using a link:https://docs.databricks.com/en/integrations/jdbc/authentication.html#databricks-personal-access-token[Personal Access Token] as a password, enter the User as 'Token'.
26+
Password::: Specify the password of the {connection} account. You can also use your '`personal access token`' generated in {connection}. For more information, see link:https://docs.microsoft.com/en-us/azure/databricks/dev-tools/api/latest/authentication#--generate-a-personal-access-token[Generate a personal access token^].
27+
link:https://docs.databricks.com/en/integrations/enable-disable-oauth.html#enable-custom-app-ui[OAuth]::
28+
xref:connections-databricks-oauth.adoc[OAuth Client ID]::: Specify the OAuth client ID.
29+
OAuth Client Secret::: Specify the OAuth client secret.
30+
Scope::: Specify the scope.
31+
Auth Url::: Specify the auth url.
32+
Access token Url::: Specify the access token url.
2933
Catalog:: Specify the catalog. _(Optional)_
3034
Example;; sample_db
3135

@@ -38,18 +42,24 @@ Host:: Enter the {connection} server hostname. For more information, see https:
3842
Example;; *abc-1234567890123456.78.azuredatabricks.net*
3943
HTTP Path:: Enter the Databricks HTTP path. For more information, see https://docs.microsoft.com/en-us/azure/databricks/integrations/bi/jdbc-odbc-bi#get-server-hostname-port-http-path-and-jdbc-url[Get server hostname, port, HTTP path, and JDBC URL^].
4044
Example;; *sql/protocolv1/o/1234567890123456/7890-123456-abc789*
41-
(Service account only) User:: Enter your login email to your Azure account.
42-
If this does not work, try "`token`".
43-
(Service account only) Password:: Enter your '`personal access token`' generated in {connection}.
44-
This is not the password for your Azure account. For more information, see https://docs.microsoft.com/en-us/azure/databricks/dev-tools/api/latest/authentication#--generate-a-personal-access-token[Generate a personal access token^].
45-
(OAuth and OAuth with PKCE only) OAuth Client ID:: Specify the OAuth client ID.
46-
(OAuth and OAuth with PKCE only) OAuth Client Secret:: Specify the OAuth client secret.
47-
(OAuth and OAuth with PKCE only) Scope:: Specify the scope.
48-
(OAuth and OAuth with PKCE only) Auth Url:: Specify the auth url.
49-
(OAuth and OAuth with PKCE only) Access token Url:: Specify the access token url.
45+
Service account::
46+
User::: Enter your login email to your Azure account.
47+
+
48+
When using a link:https://docs.databricks.com/en/integrations/jdbc/authentication.html#databricks-personal-access-token[Personal Access Token] as a password, enter the User as 'Token'.
49+
Password::: Enter your '`personal access token`' generated in {connection}.
50+
This is not the password for your Azure account. For more information, see link:https://docs.microsoft.com/en-us/azure/databricks/dev-tools/api/latest/authentication#--generate-a-personal-access-token[Generate a personal access token^].
51+
OAuth::
52+
xref:connections-databricks-oauth.adoc[OAuth Client ID]::: Specify the OAuth client ID.
53+
OAuth Client Secret::: Specify the OAuth client secret.
54+
Scope::: Specify the scope.
55+
Auth Url::: Specify the auth url.
56+
Access token Url::: Specify the access token url.
5057
Catalog:: Specify the catalog. _(Optional)_
5158
Example;; sample_db
5259

60+
== Limitation
61+
ThoughtSpot does not support link:https://docs.databricks.com/en/integrations/jdbc/authentication.html#oauth-machine-to-machine-m2m-authentication[OAuth machine-to-machine authentication], also known as Service Principal and OAuth authentication.
62+
5363
'''
5464
> **Related information**
5565
>

0 commit comments

Comments
 (0)