Habilitar ou desabilitar aplicativos OAuth parceiros

Este artigo descreve como habilitar e desabilitar aplicativos OAuth parceiros para sua conta do Azure Databricks.

Os aplicativos dbt Core, Power BI, Tableau Desktop e Tableau Cloud OAuth são habilitados por padrão para sua conta.

Habilitar aplicativos OAuth personalizados usando a interface do usuário do Azure Databricks

Você pode usar a interface do usuário do Azure Databricks para habilitar aplicativos OAuth personalizados adicionais.

Para habilitar um aplicativo OAuth personalizado na interface do usuário, faça o seguinte:

1. Inicie sessão na consola da conta e clique no ícone Definições na barra lateral.

2. Na guia Conexões de aplicativo, clique em Adicionar conexão.

3. Introduza os detalhes seguintes:

   1. Um nome para a sua ligação.

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

   3. Para escopos de acesso, os escopos determinam a quais APIs o aplicativo deve ter acesso.

      • Para aplicativos de BI, o SQL escopo é necessário para permitir que o aplicativo conectado acesse APIs SQL do Databricks.
      • Para aplicativos que precisam acessar APIs do Databricks para fins diferentes de consulta, o ALL APIs escopo é necessário.

      Os seguintes escopos são automaticamente permitidos:

      • openid, email, profile: Necessário para gerar o token de ID.
      • offline_access: Necessário para gerar tokens de atualização.

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

   4. O token de acesso time-to-live (TTL) em minutos. Padrão: 60.

   5. O token de atualização time-to-live (TTL) em minutos. Padrão: 10080.

   6. Se deve gerar um segredo do cliente. Isto é 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 da conexão, se aplicável.

4. Se você selecionou Gerar um segredo do cliente, copie e armazene o segredo do cliente com segurança. Não é possível recuperar o segredo do cliente mais tarde.

Você pode editar a URL de redirecionamento, o TTL do token e o TTL do token de atualização para aplicativos OAuth personalizados existentes na interface do usuário clicando no nome do aplicativo na página Configurações do aplicativo no console da conta. Você também pode exibir seus aplicativos OAuth publicados existentes (dbt Core, Power BI, Tableau) na interface do usuário.

Você pode desabilitar aplicativos OAuth publicados e personalizados na interface do usuário clicando no nome do aplicativo ou no menu kebab ao lado do nome do aplicativo e, em seguida, clicando em Remover.

Habilitar ou desabilitar aplicativos usando a CLI do Databricks

Esta seção descreve como usar a CLI do Databricks para desabilitar os aplicativos OAuth parceiros habilitados por padrão para sua conta e como reativá-los depois de serem desativados. Ele também descreve como habilitar e desabilitar o Tableau Server, que não está habilitado por padrão.

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 Databricks CLI e configure a autenticação entre a Databricks CLI e a sua conta do Databricks.

• Para desativar ou modificar um aplicativo OAuth existente, localize a 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.

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

Para desabilitar um aplicativo dbt Core, Power BI, Tableau Desktop ou Tableau Cloud OAuth, execute o seguinte comando, substituindo <integration-id> pela ID de integração do aplicativo OAuth que você 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

dbt Core, Power BI, Tableau Desktop e Tableau Cloud são habilitados como aplicativos OAuth em sua conta por padrão. Para reativar um desses aplicativos OAuth depois que ele for desativado, execute o seguinte comando, substituindo <application-id> por databricks-dbt-adapter, power-bitableau-desktop ou 7de584d0-b7ad-4850-b915-be7de7d58711 (Tableau Cloud):

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

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

Habilite aplicativos OAuth personalizados usando a CLI

Os aplicativos dbt Core, Power BI, Tableau Desktop e Tableau Cloud OAuth são habilitados por padrão para sua conta. Você pode usar a CLI do Azure Databricks para habilitar aplicativos OAuth personalizados adicionais.

Para conhecer as etapas para habilitar um aplicativo OAuth personalizado do Tableau Server, consulte Configurar o logon do Azure Databricks a partir do Tableau Server. Para obter etapas genéricas para habilitar qualquer aplicativo OAuth personalizado usando a CLI, consulte o seguinte:

1. Execute o 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 SQL escopo é necessário para permitir que o aplicativo conectado acesse APIs SQL do Databricks.
     • Para aplicativos que precisam acessar APIs do Databricks para fins diferentes do SQL, o ALL APIs escopo é necessário.
     • Os escopos openid, emaile são profile necessários para gerar o token de ID.
     • O offline_access escopo é necessário para gerar tokens de atualização.

   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 de cliente é gerado. Para aplicativos não públicos (confidenciais), um segredo do cliente também é gerado. A seguinte saída é retornada:

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

   Nota

   Habilitar um aplicativo OAuth pode levar 30 minutos para ser processado.

2. Guarde o segredo do cliente de forma segura, se aplicável.

   Importante

   Não é possível recuperar o segredo do cliente mais tarde.

Desabilitar aplicativos OAuth personalizados usando a CLI

Para desabilitar 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 você deseja desabilitar:

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