Pular para o conteúdo principal
Última atualização em

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.

nota

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

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

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:

  1. Faça login no consoleaccount e clique no ícone Settings (Configurações ) na barra lateral.

  2. Nas conexões do aplicativo tab, clique em Add connection (Adicionar conexão ).

  3. Insira os seguintes detalhes:

    1. Um nome para sua conexã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 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_id}/oauth2/custom-app-integrations API para criar seu aplicativo personalizado.

    4. O tempo de vida dos tokens de acesso (TTL) em minutos. Padrão: 60.

    5. O tempo de vida (TTL) dos tokens refresh 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 o ID do cliente e o segredo do cliente da sua conexão, se aplicável.

  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.

É possível editar o URL de redirecionamento, o TTL dos tokens e o TTL dos tokens refresh para os aplicativos personalizados OAuth existentes na interface do usuário, clicando no nome do aplicativo na página Settings > App connections ( Configurações de conexões de aplicativos ) no console 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 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 ).

nota

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.

nota

Você só pode configurar recursos de segurança OAuth adicionais (como tokens refresh de uso único) por meio da API. Consulte tokens refresh de uso único para habilitar tokens refresh uso único para maior segurança.

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​

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:

  1. 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 e profile são necessários para gerar os tokens de ID.
      • O escopo offline_access é necessário para gerar refresh tokens.

    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>"}
nota

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

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

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>