パートナー OAuth アプリケーションを有効または無効にする

[アーティクル]
06/05/2024

この記事では、Azure Databricks アカウントのパートナー OAuth アプリケーションを有効または無効にする方法について説明します。

dbt Core、Power BI、Tableau Desktop、Tableau Cloud などの OAuth アプリケーションは、アカウントに対して既定で有効になっています。

Note

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 アプリケーションは、アカウントに対して既定で有効になっています。 Azure Databricks CLI を使用して、追加のカスタム OAuth アプリケーションを有効にすることができます。

カスタム Tableau Server OAuth アプリケーションを有効にする手順については、「Tableau Server からの Azure 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 API にアクセスできるようにするには、SQL スコープが必要です。
  - SQL 以外の目的で Databricks API にアクセスする必要があるアプリケーションの場合は、ALL APIs スコープが必要です。
  - ID トークンを生成するには、openid、email、profile スコープが必要です。
  - 更新トークンを生成するには、offline_access スコープが必要です。
サポートされている値について詳しくは、REST API リファレンス内の「POST /api/2.0/accounts/{account_id}/oauth2/custom-app-integrations」をご参照ください。

クライアント ID が生成されます。非パブリック (機密) アプリケーションの場合、クライアントシークレットも生成されます。次の出力が返されます。
```
{"integration_id":"<integration-id>","client_id":"<client-id>","client_secret":"<client-secret>"}
```
Note

OAuth アプリケーションを有効にするには、処理に 30 分かかる場合があります。
該当する場合は、クライアントシークレットを安全に保存してください。

重要

後でクライアントシークレットを取得することはできません。

CLI を使用してカスタム OAuth アプリケーションを無効にする

既存の OAuth アプリケーション (Tableau Server など) を無効にするには、次のコマンドを実行します。<integration-id> は、無効にする OAuth アプリケーションの統合 ID に置き換えてください。

databricks account custom-app-integration delete <integration-id>

Azure Databricks UI を使用してカスタム OAuth アプリケーションを有効にする

dbt Core、Power BI、Tableau Desktop、Tableau Cloud などの OAuth アプリケーションは、アカウントに対して既定で有効になっています。 Azure Databricks UI を使用して、追加のカスタム OAuth アプリケーションを有効にすることができます。

この UI でカスタム OAuth アプリケーションを有効にするには、次のようにします。

アカウントコンソールにログインし、サイドバーの [設定] アイコンをクリックします。
[App connections] (アプリの接続) タブで、[接続の追加] をクリックします。
次の詳細を入力します。
1. 接続の名前。
2. OAuth 接続のリダイレクト URL。
3. [Access scopes] (アクセススコープ) には、アプリケーションがアクセスできる必要がある API。
  - BI アプリケーションの場合、接続されているアプリが Databricks SQL API にアクセスできるようにするには、SQL スコープが必要です。
  - クエリの実行以外の目的で Databricks API にアクセスする必要があるアプリケーションの場合は、ALL APIs スコープが必要です。
  次のスコープは自動的に許可されます。
  - openid、email、profile: ID トークンを生成するために必要です。
  - offline_access: 更新トークンを生成するために必要です。
  アプリケーションに対してこれらのスコープを許可しない場合は、POST /api/2.0/accounts/{account_id}/oauth2/custom-app-integrations API を使用してカスタムアプリケーションを作成すると、きめ細かいスコープを管理できます。
4. アクセストークンの Time-to-Live (TTL) (分)。既定値:60。
5. 更新トークンの Time-to-Live (TTL) (分)。既定値:10080。
6. クライアントシークレットを生成するかどうか。これは、パブリックでない (機密) クライアントの場合に必要です。
  
  [接続が作成されました] ダイアログボックスには、接続のクライアント ID とクライアントシークレット (該当する場合) が表示されます。
[Generate a client secret] (クライアントシークレットの生成) を選択した場合は、クライアントシークレットをコピーして安全に保存します。後でクライアントシークレットを取得することはできません。

既存のカスタム OAuth アプリケーションのリダイレクト URL、トークンの TTL、更新トークンの TTL はこの UI で編集できます。アカウントコンソールの [設定]>[App connections] (アプリ接続) ページでアプリケーション名をクリックしてください。また、既存の公開済み OAuth アプリケーション (dbt Core、Power BI、Tableau) もこの UI で表示できます。既存の公開済みアプリケーションのトークンの TTL と更新トークンの TTL を編集できます。

公開済みとカスタムのどちらの OAuth アプリケーションもこの UI で無効にすることができます。アプリケーション名またはアプリケーション名の横にあるケバブメニューをクリックし、[削除] をクリックしてください。