OAuth - Google - complemento de cuenta de servicio (obsoleto) para la nube Jitterbit y grupos de agentes privados
Introducción
El complemento Jitterbit OAuth - Google - Cuenta de Servicio se utiliza para la autenticación con la despliegue de OAuth 2 de Google para las cuentas de servicio de Google. Encontrará una guía paso a paso para configurar una cuenta de servicio de Google 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 Script, el token de autenticación se devuelve en la variable global google.oauth.token.auth
y el número de segundos de expiración se devuelve en la variable global google.oauth.token.expireSeconds
Estas variables globales pueden utilizarse posteriormente en otras partes del proyecto. Por ejemplo, google.oauth.token.auth
se puede utilizar dentro de una URL o encabezado HTTP 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 alcance el número de segundos de expiración.
Importante
Los complementos proporcionados por Jitterbit están obsoletos.
Uso
Si bien este complemento se puede ejecutar en cualquier Jitterbit Script, las variables globales que devuelve son compatibles con la configuración de estos extremos:
- Fuente HTTP de Design Studio
- Objetivo HTTP de Design Studio
- Conexión HTTP de Integration Studio
- Actividad HTTP de Integration Studio
La salida del complemento no es compatible con Integration Studio Connector Builder. En cambio, en Integration Studio puedes usar Google Docs, Google Drive, o Google Sheets conectores, 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 utilizar el complemento OAuth - Google - Cuenta de servicio:
- Descargar y agregar el complemento
- Asociar el complemento con un grupo de agentes
- Establecer variables globales para el complemento
- Ejecutar el complemento en un Jitterbit Script
- Completar la configuración de la operación
Descargue y agregue 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.
Asociar el complemento con un grupo de agentes
Si usa un grupo de agentes en la nube, puede omitir este paso, ya que el complemento Jitterbit OAuth - Google - Cuenta de servicio ya está asociado con los grupos de agentes en la nube de Jitterbit de manera predeterminada.
Si utiliza un grupo de agentes privados, debe asociar este complemento proporcionado por Jitterbit con su grupo. Esto hará que el complemento esté disponible en todos los agentes privados dentro del grupo. Para asociar el complemento:
- Inicie sesión en el portal Harmony y vaya a la Management Console. Luego, use el menú de la esquina superior izquierda para navegar a Personalizaciones > Complementos.
- En la tabla, localice la fila "Jitterbit OAuth - Google - Cuenta de servicio". En el extremo derecho, utilice el menú desplegable Acción para seleccionar Asociar Grupo de agentes.
- 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 Jitterbit Script), o se pueden configurar en un secuencia de comandos separado que se encuentra anteriormente 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:
- Creando un secuencia de comandos (Design Studio)
- Variables globales (Design Studio)
- Tipos de Secuencia de comandos y creación (Integration Studio)
- Variables globales (Integration Studio)
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:
<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 | Obligatorio | 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 que se usarán con el flujo de la cuenta de servicio. Si no hay ninguno, se establece en una cadena vacía. |
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. Si no hay ninguna, se establece en una cadena vacía. |
Consejo
Para obtener más información, consulta la documentación de Google >Uso de OAuth 2.0 para aplicaciones de servidor a servidor y Ámbitos OAuth 2.0 para las APIs de Google.
Ejecutar el complemento en un Jitterbit Script
Este complemento se puede ejecutar desde un Jitterbit Script de cualquier secuencia de comandos llamando a la función Jitterbit Script RunPlugin()
.
Las variables globales necesarias como entrada para el complemento se pueden especificar dentro del mismo secuencia de comandos en el que se complemento. Por ejemplo, el contenido del secuencia de comandos utilizado para la modelo en Establecer variables globales para el complemento podría incluirse en un solo 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 expiración se devuelve en la variable global google.oauth.token.expireSeconds
.
Cada una de estas partes del secuencia de comandos se proporcionan en esta modelo:
<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 (Integration Studio).
Completar la configuración de la operación
Las variables globales devueltas por el secuencia de comandos del complemento se pueden usar en otras partes del proyecto para la autenticación con Google. Estas variables globales son compatibles oficialmente con la configuración de estos extremos:
- Fuente HTTP de Design Studio
- Objetivo HTTP de Design Studio
- Conexión HTTP de Integration Studio
- Actividad HTTP de Integration Studio
En una configuración típica en Design Studio, la variable global google.oauth.token.auth
se puede utilizar dentro de una URL o encabezado HTTP 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 objetivo HTTP.
Alternativamente, se puede introducir en las Propiedades HTTP Avanzadas del origen o destino HTTP, en el área Encabezados de Solicitud:
De manera similar, en Integration Studio, la variable global google.oauth.token.auth
se puede utilizar en una conexión HTTP dentro del campo Encabezados de solicitud. Alternativamente, puede especificarse como Parámetro de solicitud o Encabezado de solicitud en una actividad HTTP.