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

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

dbt Core、Power BI、Tableau Desktop、および Tableau Cloud OAuth アプリケーションは、アカウントに対してデフォルトで有効になっています。

注:

OAuth アプリケーションの更新の処理には 30 分かかる場合があります。

Databricks CLI を使用してアプリを有効または無効にするEnable or disable apps using the 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-adapterpower-bitableau-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 アプリケーションを有効にするための一般的なステップについては、次を参照してください。

  1. 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 スコープが必要です。

      • SQL 以外の目的で Databricks APIs にアクセスする必要があるアプリケーションの場合は、ALL APIs スコープが必要です。

      • ID トークンを生成するには、 openidemail、および profile スコープが必要です。

      • offline_access スコープは、更新トークンを生成するために必要です。

    サポートされている値の詳細については、REST API リファレンスの 「POST /api/2.0/アカウント/{アカウント}/oauth2/custom-app-integrations 」を参照してください。

    クライアント ID が生成されます。 非公開 (機密) アプリケーションの場合、クライアント シークレットも生成されます。 次の出力が返されます。

    {"integration_id":"<integration-id>","client_id":"<client-id>","client_secret":"<client-secret>"}
    

    注:

    OAuth アプリケーションの有効化には、処理に 30 分かかる場合があります。

  2. 該当する場合は、クライアント シークレットを安全に格納します。

    重要

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

CLIを使用したカスタムOAuthアプリケーションの無効化

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

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

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

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

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

  1. アカウントコンソールにログインし、サイドバーの「設定」アイコンをクリックします。

  2. [ アプリの接続 ] タブで、[ 接続の追加] をクリックします。

  3. 次の詳細を入力します。

    1. 接続の名前。

    2. OAuth接続のリダイレクトURL。

    3. Access スコープの場合、アプリケーションがアクセスできるAPIs。

      • BI アプリケーションの場合、接続アプリケーションが Databricks SQL APIsにアクセスできるようにするには、SQL スコープが必要です。

      • クエリ以外の目的で Databricks APIs にアクセスする必要があるアプリケーションの場合は、ALL APIs スコープが必要です。

      次のスコープは自動的に許可されます。

      • openidemailprofile: ID トークンの生成に必要です。

      • offline_access: 更新トークンを生成するために必要です。

      アプリケーションでこれらのスコープを許可しない場合は、 POST /api/2.0/アカウント/{アカウント}/oauth2/custom-app-integrations カスタム アプリケーションを作成するための API。

    4. アクセストークンの有効期限 (TTL) (分単位)。 デフォルト: 60

    5. 更新トークンの有効期限 (TTL) (分単位)。 デフォルト: 10080

    6. クライアント シークレットを生成するかどうか。 これは、非公開 (機密) クライアントに必要です。

      接続が作成されました 」ダイアログ・ボックスには、接続のクライアントIDとクライアント・シークレット(該当する場合)が表示されます。

  4. [クライアント シークレットの生成] を選択した場合は、クライアント シークレットをコピーして安全に保存します。クライアント シークレットを後で取得することはできません。

既存のカスタム OAuth アプリケーションのリダイレクト URL、トークン TTL、更新トークン TTL を UI で編集するには、アカウント コンソールの [設定 ] > [アプリ接続 ] ページでアプリケーション名をクリックします。 また、既存の公開済み 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 アプリケーションを再有効化する」を参照してください。