パートナー OAuth アプリケーションを有効または無効にする
この記事では、Databricks アカウントのパートナー OAuth アプリケーションを有効または無効にする方法について説明します。
dbt Core、Power BI、Tableau Desktop、Tableau Cloud OAuth アプリケーションは、アカウントでデフォルトで有効になっています。
OAuth アプリケーションの更新は、処理に 30 分かかる場合があります。
Databricks CLI を使用してアプリを有効または無効にする
このセクションでは、 Databricks CLI を使用して、デフォルトによって有効になっているパートナー OAuth アプリケーションをアカウントに対して無効にする方法と、無効にした後で再度有効にする方法について説明します。 また、デフォルトでは有効になっていない Tableau Server を有効または無効にする方法についても説明します。
始める前に
Databricks CLI を使用してパートナー OAuth アプリケーション統合を有効または無効にする前に、次の操作を行います。
-
Databricks CLI をインストールし 、 Databricks CLI と Databricks アカウント間の認証を設定します。
-
既存の OAuth アプリケーションを無効化または変更するには、統合 ID を見つけます。
-
dbt Core、Power BI、Tableau Desktop、または Tableau Cloud の場合は、次のコマンドを実行します。
databricks account published-app-integration list
-
Tableau Server などのカスタム アプリケーションの場合は、次のコマンドを実行します。
databricks account custom-app-integration list
各 OAuth アプリケーションの一意の統合 ID が返されます。
-
CLI を使用して dbt Core、Power BI、Tableau Desktop、または Tableau Cloud OAuth アプリケーションを無効にする
dbt Core、Power BI、Tableau Desktop、Tableau Cloud OAuth アプリケーションは、アカウントでデフォルトで有効になっています。 dbt Core、Power BI、Tableau Desktop、または Tableau Cloud OAuth アプリケーションを無効にするには、次のコマンドを実行し、 <integration-id>
を削除する OAuth アプリケーションの統合 ID に置き換えます。
databricks account published-app-integration delete <integration-id>
CLI を使用して、dbt Core、Power BI、Tableau Desktop、または Tableau Cloud OAuth アプリケーションを再度有効にします
dbt Core、 Power BI、 Tableau Desktop、および Tableau Cloud は、デフォルトによってアカウント内の OAuth アプリケーションとして有効になっています。 これらの OAuth アプリケーションのいずれかを無効にした後で再度有効にするには、次のコマンドを実行して、 <application-id>
を databricks-dbt-adapter
、 power-bi
、 tableau-desktop
または 7de584d0-b7ad-4850-b915-be7de7d58711
(Tableau Cloud) に置き換えます。
databricks account published-app-integration create <application-id>
OAuth アプリケーションの一意の統合 ID が返されます。
CLI を使用したカスタム OAuth アプリケーションの有効化
dbt Core、Power BI、Tableau Desktop、Tableau Cloud OAuth アプリケーションは、アカウントでデフォルトで有効になっています。 Databricks CLI を使用して、追加のカスタム OAuth アプリケーションを有効にできます。
カスタム Tableau Server OAuth アプリケーションを有効にする手順については、 Tableau Server からの Databricks サインオンの構成を参照してください。 CLI を使用してカスタム OAuth アプリケーションを有効にする一般的な手順については、以下を参照してください。
-
custom-app-integration create
コマンドを実行します。次の例では、非公開 (機密) アプリケーションを作成します。databricks account custom-app-integration create --confidential --json '{"name":"<name>", "redirect_urls":["<redirect-url>"], "scopes":[<scopes>]}'
<name>
をカスタム OAuth アプリケーションの名前に置き換えます。<redirect-url>
をアプリケーションのリダイレクト URL に置き換えます。<scopes>
を、アプリケーションに許可するスコープの一覧に置き換えます。- BIアプリケーションの場合、接続されたアプリケーションが Databricks SQL APIsにアクセスできるようにするには、
SQL
スコープが必要です。 - DatabricksAPIs以外の目的でSQL にアクセスする必要があるアプリケーションの場合は、
ALL APIs
スコープが必要です。 openid
、email
、profile
スコープは、ID トークンを生成するために必要です。offline_access
スコープは、更新トークンを生成するために必要です。
- BIアプリケーションの場合、接続されたアプリケーションが Databricks SQL APIsにアクセスできるようにするには、
サポートされている値の詳細については、リファレンスの 「POST /api/2.0/アカウント/{アカウント}/oauth2/custom-app-integrations RESTAPI」を参照してください。
クライアント ID が生成されます。 非公開 (機密) アプリケーションの場合、クライアントシークレットも生成されます。 次の出力が返されます。
{"integration_id":"<integration-id>","client_id":"<client-id>","client_secret":"<client-secret>"}
OAuth アプリケーションの有効化は、処理に 30 分かかる場合があります。
- 該当する場合は、クライアントシークレットを安全に保管します。
クライアントシークレットを後で取得することはできません。
CLI を使用したカスタム OAuth アプリケーションの無効化
Tableau Server などの既存のカスタム OAuth アプリケーションを無効にするには、次のコマンドを実行し、 <integration-id>
を無効にする OAuth アプリケーションの統合 ID に置き換えます。
databricks account custom-app-integration delete <integration-id>
Databricks UI を使用してカスタム OAuth アプリケーションを有効にする
dbt Core、Power BI、Tableau Desktop、Tableau Cloud OAuth アプリケーションは、アカウントでデフォルトで有効になっています。 Databricks UI を使用して、追加のカスタム OAuth アプリケーションを有効にできます。
UI でカスタム OAuth アプリケーションを有効にするには、次の手順を実行します。
-
アカウントコンソールにログインし、サイドバーの [設定 ]アイコンをクリックします。
-
[ アプリの接続 ] タブで、[ 接続の追加 ] をクリックします。
-
次の詳細を入力します。
-
接続の名前。
-
OAuth 接続のリダイレクト URL。
-
アクセス スコープ の場合、アプリケーションがアクセスできるAPIs。
- BIアプリケーションの場合、接続されたアプリケーションが Databricks SQL APIsにアクセスできるようにするには、
SQL
スコープが必要です。 - クエリ以外の目的で Databricks APIs にアクセスする必要があるアプリケーションの場合は、
ALL APIs
スコープが必要です。
次のスコープが自動的に許可されます。
openid
、email
、profile
: ID トークンを生成するために必要です。offline_access
: 更新トークンを生成するために必要です。
アプリケーションでこれらのスコープを許可しない場合は、POST /api/2.0/アカウント/{アカウント}/oauth2/custom-app-integrations を使用して、きめ細かなスコープを管理できます カスタムアプリケーションを作成するためのAPI。
- BIアプリケーションの場合、接続されたアプリケーションが Databricks SQL APIsにアクセスできるようにするには、
-
アクセス トークンの有効期限 (TTL) (分単位)。 デフォルト:
60
。 -
更新トークンの有効期限 (TTL) (分単位)。 デフォルト:
10080
。 -
クライアントシークレットを生成するかどうか。 これは、非公開 (機密) クライアントの場合に必要です。
[ Connection created ] ダイアログボックスには、接続のクライアント ID とクライアントシークレット (該当する場合) が表示されます。
-
-
[ クライアント シークレットの生成] を選択した場合は、クライアント シークレットをコピーして安全に保存します。 クライアントシークレットを後で取得することはできません。
既存のカスタム OAuth アプリケーションのリダイレクト URL、トークン TTL、および更新トークン TTL を編集するには、アカウント コンソールの [ 設定 ] > [アプリ接続 ] ページでアプリケーション名をクリックします。 また、既存の公開済み OAuth アプリケーション (dbt Core、Power BI、Tableau) を UI で表示することもできます。 既存の公開アプリケーションのトークン TTL と更新トークン TTL を編集できます。
UI で公開済み OAuth アプリケーションとカスタム OAuth アプリケーションの両方を無効にするには、アプリケーション名またはアプリケーション名の横にあるケバブメニューをクリックし、[ 削除 ] をクリックします。
アプリケーションを無効にすると、アプリケーションの接続が切断されるため、OAuth アプリケーションを無効にするときは注意してください。 公開された OAuth アプリケーションを UI で無効にした場合、そのアプリケーションを UI で再度有効にすることはできません。 パブリッシュされたアプリケーションを再び有効にするには、「 CLI を使用した dbt Core、Power BI、Tableau Desktop、または Tableau Cloud OAuth アプリケーションの再有効化」を参照してください。