Ativar ou desativar aplicativos OAuth de parceiros
Este artigo descreve como habilitar e desabilitar os aplicativos parceiros OAuth para o seu Databricks account.
dbt CoreOs aplicativos Power BI, Tableau Desktop e Tableau Cloud OAuth são habilitados pelo default para o seu account.
As atualizações dos aplicativos OAuth podem levar 30 minutos para serem processadas.
Ativar ou desativar aplicativos usando a CLI da Databricks
Esta seção descreve como usar o Databricks CLI para desativar os aplicativos parceiros OAuth que são ativados pelo default para o seu account e como reativá-los depois de terem sido desativados. Ele também descreve como ativar e desativar o Tableau Server, que não é ativado pelo default.
Antes de começar
Antes de ativar ou desativar as integrações de aplicativos OAuth de parceiros usando a CLI da Databricks, faça o seguinte:
-
Instale o Databricks CLIe configure a autenticação entre o Databricks CLI e seu Databricks account .
-
Para desativar 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 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
dbt CoreOs aplicativos Power BI, Tableau Desktop e Tableau Cloud OAuth são habilitados pelo default para o seu account. Para desativar um aplicativo dbt Core, Power BI, Tableau Desktop ou Tableau Cloud OAuth , execute o seguinte comando, substituindo <integration-id>
pelo ID de integração do aplicativo OAuth que o senhor 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 ativados como aplicativos OAuth em seu 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.
Habilitar aplicativos OAuth personalizados usando a CLI
dbt CoreOs aplicativos Power BI, Tableau Desktop e Tableau Cloud OAuth são habilitados pelo default para o seu account. O senhor pode usar a CLI da Databricks para ativar aplicativos OAuth personalizados adicionais.
Para obter as etapas para habilitar um aplicativo OAuth personalizado do Tableau Server, consulte Configurar o logon do Databricks no Tableau Server. Para ver as etapas genéricas para ativar qualquer aplicativo OAuth personalizado usando a CLI, consulte o seguinte:
-
execução do
custom-app-integration create
comando. 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 BI, o escopo
SQL
é necessário para permitir que o aplicativo conectado acesse Databricks SQL APIs. - Para aplicativos que precisam acessar as APIs do Databricks para outros fins que não o SQL, é necessário o escopo
ALL APIs
. - Os escopos
openid
,email
eprofile
são necessários para gerar os tokens de ID. - O escopo
offline_access
é necessário para gerar refresh tokens.
- Para aplicativos BI, o escopo
Para obter mais informações sobre os valores suportados, consulte POST /api/2.0/account/{account}/oauth2/custom-app-integrations na referência REST API .
Uma ID de cliente é gerada. Para aplicativos não públicos (confidenciais), um segredo de cliente também é gerado. A saída a seguir é retornada:
{"integration_id":"<integration-id>","client_id":"<client-id>","client_secret":"<client-secret>"}
- Substitua
A ativação de um aplicativo OAuth pode levar 30 minutos para ser processada.
- Armazene com segurança o segredo do cliente, se aplicável.
Você não pode recuperar o segredo do cliente posteriormente.
Desativar aplicativos OAuth personalizados usando a CLI
Para desativar um aplicativo OAuth personalizado existente, como Tableau Server, execute o seguinte comando, substituindo <integration-id>
pelo ID de integração do aplicativo OAuth que o senhor deseja desativar:
databricks account custom-app-integration delete <integration-id>
Habilitar aplicativos OAuth personalizados usando a interface do usuário do Databricks
dbt CoreOs aplicativos Power BI, Tableau Desktop e Tableau Cloud OAuth são habilitados pelo 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 interface do usuário, faça o seguinte:
-
Faça login no consoleaccount e clique no ícone Settings (Configurações ) na barra lateral.
-
Nas conexões do aplicativo tab, clique em Add connection (Adicionar conexão ).
-
Insira os seguintes detalhes:
-
Um nome para sua conexão.
-
Os URLs de redirecionamento para sua conexão OAuth.
-
Para escopos de acesso , as APIs às quais o aplicativo deve ter acesso.
- Para aplicativos BI, o escopo
SQL
é necessário para permitir que o aplicativo conectado acesse Databricks SQL APIs. - Para aplicativos que precisam acessar as APIs do Databricks para outros fins que não a consulta, é necessário o escopo
ALL APIs
.
Os seguintes escopos são permitidos automaticamente:
openid
,email
,profile
: Necessário para gerar os tokens de ID.offline_access
: Necessário para gerar refresh tokens.
Se não quiser permitir esses escopos para o aplicativo, o usuário pode gerenciar escopos refinados usando o comando POST /api/2.0/account/{account}/oauth2/custom-app-integrations API para criar seu aplicativo personalizado.
- Para aplicativos BI, o escopo
-
O tempo de vida dos tokens de acesso (TTL) em minutos. Padrão:
60
. -
O tempo de vida (TTL) dos tokens refresh em minutos. Padrão:
10080
. -
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 pode recuperar o segredo do cliente posteriormente.
É possível editar o URL de redirecionamento, o TTL dos tokens e o TTL dos tokens do refresh para aplicativos personalizados existentes do OAuth na interface do usuário, clicando no nome do aplicativo na página Settings > App connections ( Configurações > Conexões de aplicativos ) no console do account. O senhor também pode acessar view os aplicativos OAuth já publicados (dbt Core, Power BI, Tableau) na interface do usuário. O senhor pode editar o TTL dos tokens e refresh o TTL dos tokens dos aplicativos publicados existentes.
O senhor pode desativar os 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 Remove (Remover ).
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.