Habilitar ou desabilitar aplicativos OAuth de parceiros

Artigo
06/05/2024

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

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

Observação

As atualizações para 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 do Databricks para desabilitar os aplicativos OAuth de parceiros habilitados por padrão para sua conta e como habilitá-los novamente depois que eles tiverem sido desabilitados. 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 as 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 conta do Databricks.
Para desabilitar ou modificar um aplicativo OAuth existente, localize a ID de integração.
- Para o dbt Core, Power BI, Tableau Desktop ou Tableau Cloud, execute o comando a seguir:
```
databricks account published-app-integration list
```
- Para aplicativos personalizados, como o Tableau Server, execute o seguinte comando:
```
databricks account custom-app-integration list
```
A ID de integração exclusiva para cada aplicativo OAuth é retornada.

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

Os aplicativos dbt Core, Power BI, Tableau Desktop e Tableau Cloud OAuth estão habilitados por padrão para sua conta. Para desabilitar um aplicativo dbt Core, Power BI, Tableau Desktop ou Tableau 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>

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

O dbt Core, Power BI, Tableau Desktop e Tableau Cloud estão habilitados como aplicativos OAuth em sua conta por padrão. Para habilitar novamente um desses aplicativos OAuth depois de desabilitado, 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>

A ID de integração exclusiva para o aplicativo OAuth é retornada.

Habilitar aplicativos OAuth personalizados usando a CLI

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

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

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 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 SQL do Databricks.
  - Para aplicativos que precisam acessar APIs do Databricks para fins diferentes do SQL, o escopo ALL APIs é necessário.
  - Os escopos openid, email e profile são necessários para gerar o token da ID.
  - O escopo offline_access é necessário para gerar tokens de atualização.
Para obter mais informações sobre valores com suporte, confira POST /api/2.0/accounts/{account_id}/oauth2/custom-app-integrations na referência da API REST.

Uma ID do cliente é gerada. Para aplicativos não públicos (confidenciais), um segredo do cliente também é gerado. A seguinte saída será retornada:
```
{"integration_id":"<integration-id>","client_id":"<client-id>","client_secret":"<client-secret>"}
```
Observação

A habilitação de um aplicativo OAuth pode levar 30 minutos para ser processada.
Armazene com segurança o segredo do cliente, se aplicável.

Importante

Você não poderá 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>

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

Os aplicativos dbt Core, Power BI, Tableau Desktop e Tableau Cloud OAuth estão habilitados por padrão para sua conta. 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:

Faça logon no console da conta e clique no ícone Configurações na barra lateral.
Na guia Conexões de aplicativo, clique em Adicionar conexão.
Insira os seguintes detalhes:
1. Um nome para a conexão.
2. As URLs de redirecionamento para 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 SQL do Databricks.
  - Para aplicativos que precisam acessar APIs do Databricks para finalidades diferentes de consulta, o escopo ALL APIs é necessário.
  Os seguintes escopos são permitidos automaticamente:
  - openid, email e profile: necessários para gerar o token da ID.
  - offline_access: necessário para gerar tokens de atualização.
  Se 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 TTL (tempo de vida útil) do token de acesso em minutos. Padrão: 60.
5. O TTL (tempo de vida útil) do token de atualização em minutos. Padrão: 10080.
6. Se deve gerar um segredo de cliente. Isso é necessário para clientes não públicos (confidenciais).
  
  A caixa de diálogo Conexão criada exibe a ID do cliente e o segredo do cliente, se aplicável, para sua conexão.
Se você selecionou Gerar um segredo do cliente, copie e armazene com segurança o segredo do cliente. Você não poderá 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>Conexõ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 editar o TTL do token e o TTL do token de atualização para aplicativos publicados existentes.

É possível desabilitar aplicativos OAuth publicados e personalizados na interface do usuário clicando no nome do aplicativo ou no menu kebab ao lado dele e selecionando Remover.

Observação

Desabilitar um aplicativo interrompe a conexão do aplicativo, portanto, tenha cuidado ao desabilitar aplicativos OAuth. Se você desabilitar um aplicativo OAuth publicado na interface do usuário, ele não poderá ser habilitado novamente na interface do usuário. Para habilitar novamente um aplicativo publicado, confira Habilitar novamente o aplicativo dbt Core, Power BI, Tableau Desktop ou Tableau Cloud OAuth usando a CLI.

Compartilhar via