Saltar al contenido

OAuth - Google - Service Account

Introducción

El complemento Jitterbit OAuth - Google - Service Account se usa para autenticarse con la implementación de Google de OAuth 2 para las cuentas de servicio de Google. Una guía paso a paso para configurar una cuenta de servicio de Google está disponible en la documentación de Google Uso de OAuth 2.0 para aplicaciones de servidor a servidor.

Después de que el complemento se ejecuta en un Jitterbit Secuencia de Comandos, el token de autenticación se devuelve en la variable global google.oauth.token.auth y el número de segundos de vencimiento se devuelve en la variable global google.oauth.token.expireSeconds.

Estas variables globales se pueden usar en otras partes del proyecto. Por ejemplo, google.oauth.token.authse puede usar dentro de una URL HTTP o un encabezado para proporcionar los detalles de autenticación a Google. La variable google.oauth.token.expireSeconds se puede usar para almacenar en caché el token de autorización hasta que se alcanza la cantidad de segundos de vencimiento.

Importante

Los complementos proporcionados por Jitterbit están obsoletos. Ver Obsolescencia y soporte en Complementos.

Uso

Si bien este complemento se puede ejecutar en cualquier Jitterbit Secuencia de Comandos, las variables globales que devuelve son compatibles con la configuración de estos extremos:

La salida del complemento no es compatible con Cloud Studio Connector Builder. En cambio, en Cloud Studio puede usar Documentos de Google, Google Drive o Hojas de cálculo de Google, que ya proporcionan un medio de autenticación con el servicio de Google durante la configuración del extremo.

Pasos

Esta página detalla los pasos para usar el complemento OAuth - Google - Cuenta de servicio:

  1. Descargar y agregar el complemento
  2. Asociar el complemento con un Grupo de Agentes
  3. Establecer variables globales para el complemento
  4. Ejecute el complemento en un Secuencia de Comandos de Jitterbit
  5. Complete la configuración de la operación

Descargar y Agregar el Complemento

El complemento Jitterbit OAuth - Google - Cuenta de servicio debe descargarse en el enlace que se proporciona a continuación y agregarse a la organización (consulte Agregar nuevos complementos en Personalizaciones > Complementos).

Asociar el Complemento con un Grupo de Agentes

Si usa un Grupo de Agentes en Nube, puede omitir este paso, ya que el complemento Jitterbit OAuth - Google - Service Account ya está asociado con los Grupos de Agentes en Nube de Jitterbit de manera predeterminada.

Si utiliza un Grupo de Agentes Privados, debe asociar este complemento proporcionado por Jitterbit con su Grupo de Agentes Privados. Esto hará que el complemento esté disponible en todos los Agentes Privados dentro del Grupo de Agentes Privados. Para asociar el complemento:

  1. Inicie sesión en el Portal de Harmony y vaya a la Management Console. Luego use el menú en la parte superior izquierda para navegar a Personalizaciones > Complementos.
  2. En la tabla, busque la fila "Jitterbit OAuth - Google - Cuenta de servicio". En el extremo derecho, use el menú desplegable Acción para seleccionar Grupo de Agentes asociados.
  3. En la ventana emergente, seleccione su Grupo de Agentes Privados y haga clic en Guardar.

Consejo

La documentación detallada sobre la asociación de complementos está disponible en Personalizaciones > Complementos.

Establecer Variables Globales para el Complemento

Para que este complemento sea funcional, se deben configurar las variables globales requeridas como entrada por el complemento.

Estas variables globales se pueden configurar en el mismo secuencia de comandos que ejecuta el complemento (que se explica a continuación en Ejecutar el complemento en un Secuencia de Comandos de Jitterbit), o se pueden configurar en un secuencia de comandos separado que se encuentra antes en la cadena de operación (para que las variables se inicialicen antes de la ejecución del complemento).

Consejo

Para obtener más información, consulte estas páginas:

A continuación se proporciona una modelo de secuencia de comandos, seguida de documentación sobre cada una de las variables globales de entrada que se pueden usar con el complemento:

Setting Input Variables
<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>
Nombre Tipo Requerido Descripción
google.oauth.privateKey Cadena Obligatorio La clave privada RSA que se proporciona a través de JSON en el campo "private_key" de Google.
google.oauth.clientEmail Cadena Obligatorio El correo del cliente proporcionado a través de JSON en el campo "client_email" de Google.
google.oauth.accountScopes Cadena Opcional Los ámbitos de OAuth separados por espacios para usar con el flujo de la cuenta de servicio. Establézcalo en una cadena vacía para ninguno.
google.oauth.serviceAccountUser Cadena Opcional La dirección de correo del usuario que la aplicación intenta suplantar en el flujo de la cuenta de servicio. Establézcalo en una cadena vacía para ninguno.

Consejo

Para obtener más detalles, consulte la documentación de Google >Using OAuth 2.0 for Server to Server Applications y Ámbitos de OAuth 2.0 para las API de Google.

Ejecute el Complemento en un Secuencia de Comandos de Jitterbit

Este complemento se puede ejecutar desde un Jitterbit Secuencia de Comandos de cualquier tipo de secuencia de comandos llamando a la función Jitterbit Secuencia de Comandos RunPlugin().

Las variables globales necesarias como entrada para el complemento se pueden especificar dentro del mismo secuencia de comandos en el que se ejecuta el complemento. Por ejemplo, el contenido de la secuencia de comandos utilizada para la modelo en Establecer variables globales para el complemento podría incluirse en un único secuencia de comandos que también ejecute el complemento.

Después de ejecutar el complemento, el token de autenticación se devuelve en la variable global google.oauth.token.auth y el número de segundos de vencimiento se devuelve en la variable global google.oauth.token.expireSeconds.

Cada una de estas partes del secuencia de comandos se proporcionan en esta modelo:

Setting Input Variables and Executing the 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 = '';

// 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>
Nombre Descripción
google.oauth.token.auth El token de autenticación de Google.
google.oauth.expireSeconds La cantidad de segundos hasta que caduque el token de autenticación de Google.

Consejo

La documentación detallada sobre la ejecución de complementos desde un secuencia de comandos está disponible en Complementos (Design Studio) o Complementos llamados en un Secuencia de Comandos (Cloud Studio).

Complete la Configuración de la Operación

Las variables globales devueltas por la secuencia de comandos del complemento se pueden usar en otras partes del proyecto para la autenticación con Google. Estas variables globales se admiten oficialmente dentro de la configuración de estos extremos:

En una configuración típica en Design Studio, la variable global google.oauth.token.auth se puede usar dentro de una URL HTTP o un encabezado para proporcionar los detalles de autenticación a Google.

Esto se puede concatenar con el alojar de Google en el campo URL de una fuente HTTP o destino HTTP.

Alternativamente, podría ingresarse en el origen o destino HTTP Propiedades HTTP avanzadas en el área Encabezados de solicitud:

encabezados de solicitud

De manera similar, en Cloud Studio, la variable global google.oauth.token.auth se puede utilizar en una conexión HTTP dentro del campo Encabezados de solicitud. Alternativamente, se puede especificar como Parámetro de solicitud o Encabezado de solicitud en una actividad HTTP.