OAuth - Google - Plugin de Conta de Serviço (obsoleto) para grupos de agentes Jitterbit em nuvem e privados
Introdução
O plugin OAuth - Google - Conta de Serviço do Jitterbit é utilizado para autenticar com a implementação do OAuth 2 do Google para contas de serviço do Google. Um guia passo a passo para configurar uma conta de serviço do Google está disponível na documentação do Google Usando OAuth 2.0 para Aplicações de Servidor a Servidor.
Após a execução do plugin em um Script Jitterbit, o token de autenticação é retornado na variável global google.oauth.token.auth e o número de segundos até a expiração é retornado na variável global google.oauth.token.expireSeconds.
Essas variáveis globais podem ser utilizadas em outras partes do projeto. Por exemplo, google.oauth.token.auth pode ser usado dentro de uma URL HTTP ou cabeçalho para fornecer os detalhes de autenticação ao Google. A variável google.oauth.token.expireSeconds pode ser usada para armazenar em cache o token de autorização até que o número de segundos de expiração seja atingido.
Importante
Plugins fornecidos pelo Jitterbit estão obsoletos.
Uso
Embora este plugin possa ser executado em qualquer Script Jitterbit, as variáveis globais que ele retorna são suportadas dentro da configuração desses endpoints:
- Fonte HTTP do Design Studio
- Alvo HTTP do Design Studio
- Conexão HTTP do Integration Studio
- Atividade HTTP do Integration Studio
A saída do plugin não é suportada no Construtor de Conectores do Integration Studio. Em vez disso, no Integration Studio, você pode usar os conectores Google Docs, Google Drive ou Google Sheets, que já fornecem um meio de autenticação com o serviço Google durante a configuração do endpoint.
Passos
Esta página detalha os passos para usar o plugin OAuth - Google - Service Account:
- Baixar e adicionar o plugin
- Associar o plugin a um grupo de agentes
- Definir variáveis globais para o plugin
- Executar o plugin em um Script Jitterbit
- Completar a configuração da operação
Baixar e adicionar o plugin
O plugin Jitterbit OAuth - Google - Service Account deve ser baixado no link fornecido abaixo e adicionado à organização.
Associar o plugin a um grupo de agentes
Se estiver usando um grupo de agentes em nuvem, você pode pular esta etapa, pois o plugin Jitterbit OAuth - Google - Service Account já está associado aos grupos de agentes em nuvem do Jitterbit por padrão.
Se estiver usando um grupo de agentes privado, você deve associar este plugin fornecido pelo Jitterbit ao seu grupo de agentes privado. Isso tornará o plugin disponível em todos os agentes privados dentro do grupo de agentes privado. Para associar o plugin:
- Faça login no portal Harmony e vá para o Console de Gerenciamento. Em seguida, use o menu no canto superior esquerdo para navegar até Personalizações > Plug-ins.
- Na tabela, localize a linha "Jitterbit OAuth - Google - Service Account." À direita, use o menu suspenso Ação para selecionar Associar Grupo de Agentes.
- Na janela pop-up, selecione seu grupo de agentes privado e clique em Salvar.
Dica
A documentação detalhada sobre a associação de plugins está disponível em Personalizações > Plug-ins.
Definir variáveis globais para o plugin
Para que este plugin funcione, as variáveis globais necessárias como entrada pelo plugin devem ser definidas.
Essas variáveis globais podem ser definidas no mesmo script que executa o plugin (coberto a seguir em Executar o plugin em um Script Jitterbit), ou podem ser definidas em um script separado que está localizado anteriormente na cadeia de operações (para que as variáveis sejam inicializadas antes da execução do plugin).
Dica
Para mais informações, consulte estas páginas:
- Criando um script (Design Studio)
- Variáveis globais (Design Studio)
- Tipos de script e criação (Integration Studio)
- Variáveis globais (Integration Studio)
Um modelo de script é fornecido abaixo, seguido pela documentação sobre cada uma das variáveis globais de entrada que podem ser usadas com o plugin:
<trans>
// Input variables
$google.oauth.privateKey = "-----BEGIN PRIVATE KEY-----\nABCDEfg...HIJKLMN\n-----END PRIVATE KEY-----\n";
$google.oauth.clientEmail = "example@example-123456.iam.gserviceaccount.com";
$google.oauth.accountScopes = "https://www.googleapis.com/auth/bigquery";
$google.oauth.serviceAccountUser = '';
</trans>
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
google.oauth.privateKey |
String | Obrigatório | A chave privada RSA que é fornecida via JSON no campo "private_key" do Google. |
google.oauth.clientEmail |
String | Obrigatório | O email do cliente fornecido via JSON no campo "client_email" do Google. |
google.oauth.accountScopes |
String | Opcional | Os escopos OAuth separados por espaço a serem usados com o fluxo da conta de serviço. Defina como uma string vazia para nenhum. |
google.oauth.serviceAccountUser |
String | Opcional | O endereço de email do usuário que o aplicativo está tentando impersonar no fluxo da conta de serviço. Defina como uma string vazia para nenhum. |
Dica
Para detalhes adicionais, consulte a documentação do Google >Usando OAuth 2.0 para Aplicações de Servidor a Servidor e Escopos OAuth 2.0 para APIs do Google.
Execute o plugin em um Script Jitterbit
Este plugin pode ser executado a partir de um Script Jitterbit de qualquer tipo de script chamando a função do Script Jitterbit RunPlugin().
As variáveis globais necessárias como entrada para o plugin podem ser especificadas dentro do mesmo script em que o plugin é executado. Por exemplo, o conteúdo do script usado para o template em Definir variáveis globais para o plugin poderia ser incluído em um único script que também executa o plugin.
Após a execução do plugin, o token de autenticação é retornado na variável global google.oauth.token.auth e o número de segundos até a expiração é retornado na variável global google.oauth.token.expireSeconds.
Cada uma dessas partes do script é fornecida neste template:
<trans>
// Input variables
$google.oauth.privateKey = "-----BEGIN PRIVATE KEY-----\nABCDEfg...HIJKLMN\n-----END PRIVATE KEY-----\n";
$google.oauth.clientEmail = "example@example-123456.iam.gserviceaccount.com";
$google.oauth.accountScopes = "https://www.googleapis.com/auth/bigquery";
$google.oauth.serviceAccountUser = '';
// Output variables
$google.oauth.token.auth = '';
$google.oauth.token.expireSeconds = '';
// Executing the plugin
RunPlugin("<TAG>plugin:http://www.jitterbit.com/plugins/pipeline/user/OAuthGoogleServiceAccount</TAG>");
</trans>
| Nome | Descrição |
|---|---|
google.oauth.token.auth |
O token de autenticação do Google. |
google.oauth.expireSeconds |
O número de segundos até que o token de autenticação do Google expire. |
Dica
A documentação detalhada sobre a execução de plugins a partir de um script está disponível em Plugins (Design Studio) ou Plugins chamados em um script (Integration Studio).
Complete a configuração da operação
As variáveis globais retornadas pelo script do plugin podem ser usadas em outras partes do projeto para autenticação com o Google. Essas variáveis globais são oficialmente suportadas dentro da configuração desses endpoints:
- Design Studio HTTP source
- Design Studio HTTP target
- Integration Studio HTTP connection
- Integration Studio HTTP activity
Em uma configuração típica no Design Studio, a variável global google.oauth.token.auth pode ser usada dentro de uma URL HTTP ou cabeçalho para fornecer os detalhes de autenticação ao Google.
Isso pode ser concatenado com o host do Google no campo URL de uma HTTP source ou HTTP target.
Alternativamente, pode ser inserido na fonte ou destino HTTP nas Advanced HTTP Properties na área de Request Headers:
Da mesma forma, no Integration Studio, a variável global google.oauth.token.auth pode ser usada em uma HTTP connection dentro do campo Request Headers. Alternativamente, pode ser especificada como um Request Parameter ou um Request Header em uma HTTP activity.