Habilitar ou desabilitar aplicativos OAuth de parceiros

Este artigo descreve como habilitar e desabilitar aplicativos OAuth de parceiros para sua account do Databricks.

Os aplicativos OAuth do dbt Core, Power BI, Tableau Desktop e Tableau Cloud são habilitados por default para o seu account.

Observação

As atualizações nos aplicativos OAuth podem levar 30 minutos para serem processadas.

Habilitar ou desabilitar aplicativos usando a CLI do Databricks

Esta seção descreve como usar a CLI da Databricks para desativar os aplicativos OAuth de parceiros que são ativados por default para o seu account e como reativá-los depois de terem sido desativados. Ele também descreve como habilitar e desabilitar o Tableau Server, que não é habilitado pelo site default.

Antes de começar

Antes de habilitar ou desabilitar integrações de aplicativos OAuth de parceiros usando a CLI do Databricks, faça o seguinte:

  • Instale a CLI do Databricks e configure a autenticação entre a CLI do Databricks e sua accountdo Databricks.

  • Para desabilitar ou modificar um aplicativo OAuth existente, localize o ID de integração.

    • Para dbt Core, Power BI, Tableau Desktop ou Tableau Cloud, execute o seguinte comando:

      databricks account published-app-integration list
      
    • Para aplicativos personalizados, como o Tableau Server, execute o seguinte comando:

      databricks account custom-app-integration list
      

    O ID de integração exclusivo para cada aplicativo OAuth é retornado.

Desativar o aplicativo dbt Core, Power BI, Tableau Desktop ou Tableau Cloud OAuth usando a CLI

Os aplicativos OAuth do dbt Core, Power BI, Tableau Desktop e Tableau Cloud são habilitados por default para o seu account. Para desativar um aplicativo OAuth do dbt Core, Power BI, Tableau Desktop ou Tableau Cloud, execute o seguinte comando, substituindo <integration-id> pela ID de integração do aplicativo OAuth que deseja excluir:

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

Reative o aplicativo dbt Core, Power BI, Tableau Desktop ou Tableau Cloud OAuth usando a CLI

O dbt Core, o Power BI, o Tableau Desktop e o Tableau Cloud são habilitados como aplicativos OAuth em seu site account por default. Para reativar um desses aplicativos OAuth depois de ter sido desativado, execute o seguinte comando, substituindo <application-id> por databricks-dbt-adapter, power-bi, tableau-desktop ou 7de584d0-b7ad-4850-b915-be7de7d58711 (Tableau Cloud):

databricks account published-app-integration create <application-id>

O ID de integração exclusivo do aplicativo OAuth é retornado.

Habilite aplicativos OAuth personalizados usando a CLI

Os aplicativos OAuth do dbt Core, Power BI, Tableau Desktop e Tableau Cloud são habilitados por default para o seu account. O senhor pode usar a CLI da Databricks para ativar aplicativos OAuth personalizados adicionais.

Para obter os passos para habilitar um aplicativo OAuth personalizado do Tableau Server, consulte Configurar o logon do Databricks no Tableau Server. Para obter os passos genéricos para ativar qualquer aplicativo OAuth personalizado usando a CLI, consulte o seguinte:

  1. execução do comando custom-app-integration create . O exemplo a seguir cria um aplicativo não público (confidencial):

    databricks account custom-app-integration create --confidential --json '{"name":"<name>", "redirect_urls":["<redirect-url>"], "scopes":[<scopes>]}'
    
    • Substitua <name> por um nome para seu aplicativo OAuth personalizado.

    • Substitua <redirect-url> pelos URLs de redirecionamento do seu aplicativo.

    • Substitua <scopes> pela lista de escopos que você deseja permitir para o aplicativo.

      • Para aplicativos de BI, o escopo SQL é necessário para permitir que o aplicativo conectado acesse APIs Databricks SQL .

      • Para aplicativos que precisam acessar APIs do Databricks para outras finalidades que não SQL, o escopo ALL APIs é necessário.

      • Os escopos openid, email e profile são necessários para gerar os tokens de ID.

      • O escopo offline_access é necessário para gerar tokens refresh .

    Para obter mais informações sobre valores suportados, consulte POST /api/2.0/accounts/{account_id}/oauth2/custom-app-integrations na referência da API REST.

    Um ID do cliente é gerado. Para aplicações não públicas (confidenciais), também é gerado um segredo do cliente. A seguinte saída é retornada:

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

    Observação

    A ativação de um aplicativo OAuth pode levar 30 minutos para ser processada.

  2. Armazene com segurança o segredo do cliente, se aplicável.

    Importante

    Você não pode recuperar o segredo do cliente posteriormente.

Desative aplicativos OAuth personalizados usando a CLI

Para desativar um aplicativo OAuth personalizado existente, como o Tableau Server, execute o seguinte comando, substituindo <integration-id> pela ID de integração do aplicativo OAuth que deseja desativar:

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

Habilitar aplicativos OAuth personalizados usando a UI do Databricks

Os aplicativos OAuth do dbt Core, Power BI, Tableau Desktop e Tableau Cloud são habilitados por default para o seu account. O senhor pode usar a interface do usuário do Databricks para ativar aplicativos OAuth personalizados adicionais.

Para ativar um aplicativo OAuth personalizado na IU, faça o seguinte:

  1. log in no consoleaccount e clique no ícone Configurações na barra lateral.

  2. Na Conexões de aplicativos tab, clique em Adicionar conexão.

  3. Insira os seguintes detalhes:

    1. Um nome para sua conexão.

    2. Os URLs de redirecionamento da sua conexão OAuth.

    3. Para escopos de acesso, as APIs às quais o aplicativo deve ter acesso.

      • Para aplicativos de BI, o escopo SQL é necessário para permitir que o aplicativo conectado acesse APIs Databricks SQL .

      • Para aplicativos que precisam acessar APIs do Databricks para outras finalidades que não a consulta, o escopo ALL APIs é necessário.

      Os seguintes escopos são permitidos automaticamente:

      • openid, email, profile: Necessário para gerar os tokens de ID.

      • offline_access: necessário para gerar tokens refresh .

      Se não quiser permitir esses escopos para o aplicativo, você pode gerenciar escopos detalhados usando o POST /api/2.0/accounts/{account_id}/oauth2/custom-app-integrations API para criar seu aplicativo personalizado.

    4. O tempo de vida access token (TTL) em minutos. default: 60.

    5. O tempo de vida dos tokens refresh (TTL) em minutos. default: 10080.

    6. Se deve gerar um segredo do cliente. Isso é necessário para clientes não públicos (confidenciais).

      A caixa de diálogo Conexão criada exibe o ID do cliente e o segredo do cliente, se aplicável, para sua conexão.

  4. Se você selecionou Gerar um segredo do cliente, copie e armazene com segurança o segredo do cliente. Você não pode recuperar o segredo do cliente posteriormente.

Você pode editar o URL de redirecionamento, o TTL dos tokens e o TTL dos tokens de refresh para aplicativos OAuth personalizados existentes na IU clicando no nome do aplicativo na página Configurações > Conexões do aplicativo no console da account . Você também pode view seus aplicativos OAuth publicados existentes (dbt Core, Power BI, Tableau) na interface do usuário. Você pode editar o TTL dos tokens e refresh o TTL dos tokens para aplicativos publicados existentes.

Você pode desabilitar aplicativos OAuth publicados e personalizados na UI clicando no nome do aplicativo ou nas reticências verticais ao lado do nome do aplicativo e clicando em Remover.

Observação

A desativação de um aplicativo interrompe a conexão do aplicativo, portanto, tenha cuidado ao desativar os aplicativos OAuth. Se o senhor desativar um aplicativo OAuth publicado na interface do usuário, ele não poderá ser reativado na interface do usuário. Para reativar um aplicativo publicado, consulte Reativar o aplicativo dbt Core, Power BI, Tableau Desktop ou Tableau Cloud OAuth usando a CLI.