SDK de Admin de Google Workspace

El conector del SDK de Admin de Google Workspace te permite realizar las operaciones admitidas en el SDK de Admin de Google Workspace.

Antes de comenzar

Antes de usar el conector del SDK de Admin de Google Workspace, realiza las siguientes tareas:

  • En tu proyecto de Google Cloud, haz lo siguiente:
    • Otorga el rol de IAM roles/connectors.admin al usuario que configure el conector.
    • Otorga los siguientes roles de IAM a la cuenta de servicio que deseas usar para el conector:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Una cuenta de servicio es un tipo de Cuenta de Google especial que representa a un usuario no humano que debe autenticarse y tener autorización para acceder a los datos de las APIs de Google. Si no tienes una cuenta de servicio, debes crear una. Para obtener más información, consulta Crea una cuenta de servicio.

    • Habilita los siguientes servicios:
      • secretmanager.googleapis.com (API de Secret Manager)
      • connectors.googleapis.com (API de conectores)

      Para comprender cómo habilitar servicios, consulta Habilita servicios.

    Si estos servicios o permisos no se habilitaron antes para tu proyecto, se te solicitará que los habilites cuando configures el conector.

  • Si usas la autenticación de cuenta de servicio en vez de OAuth 2.0, asegúrate de de que se otorguen los permisos adecuados a la cuenta de servicio. Para obtener más información, consulta Funciones y permisos de IAM.

Configura el conector

Para configurar el conector, debes crear una conexión a tu fuente de datos (sistema de backend). Una conexión es específica de una fuente de datos. Significa que, si tienes muchas fuentes de datos, debes crear una conexión independiente para cada fuente. Para crear una conexión, sigue estos pasos:

  1. En la consola de Cloud, ve a la página Conectores de Integration > Conexiones y, luego, selecciona o crea un proyecto de Google Cloud.

    Ir a la página Conexiones

  2. Haz clic en + Crear nuevo para abrir la página Crear conexión.
  3. En la sección Ubicación, elige la ubicación para la conexión.
    1. Región: selecciona una ubicación de la lista desplegable.

      Para obtener la lista de todas las regiones compatibles, consulta Ubicaciones.

    2. Haz clic en Siguiente.
  • En la sección Detalles de la conexión, establece los siguientes campos:
    1. Conector: Selecciona SDK de Admin de Google Workspace en la lista desplegable de conectores disponibles.
    2. Versión del conector: Selecciona la versión del conector de la lista desplegable de versiones disponibles.
    3. En el campo Nombre de la conexión, ingresa un nombre para la instancia de conexión.

      Los nombres de las conexiones deben cumplir con los siguientes criterios:

      • Los nombres de las conexiones pueden usar letras, números o guiones.
      • Las letras deben estar en minúsculas.
      • Los nombres de las conexiones deben comenzar con una letra y terminar con una letra o un número.
      • Los nombres de las conexiones no pueden superar los 63 caracteres.
    4. De manera opcional, ingresa una Descripción para la instancia de conexión.
    5. De manera opcional, selecciona Habilitar Cloud Logging si quieres registrar los detalles de ejecución del conector.
    6. Cuenta de servicio: Selecciona una cuenta de servicio que tenga los roles necesarios.
    7. De manera opcional, configura los parámetros de nodo de conexión:

      • Cantidad mínima de nodos: Ingresa la cantidad mínima de nodos de conexión.
      • Cantidad máxima de nodos: Ingresa la cantidad máxima de nodos de conexión.

      Un nodo es una unidad (o réplica) de una conexión que procesa transacciones. Se requieren más nodos para procesar más transacciones para una conexión y, del mismo modo, se requieren menos para procesar menos transacciones. Para comprender cómo los nodos afectan el precio del conector, consulta Precios de nodos de conexión. Si no ingresas ningún valor, se establecen de forma predeterminada los nodos mínimos en 2 (para una mejor disponibilidad) y los nodos máximos se establecen en 50.

    8. De manera opcional, haz clic en + Agregar etiqueta para agregar una etiqueta a la conexión en forma de par clave-valor.
    9. Haz clic en Siguiente.
    10. En la sección Autenticación, ingresa los detalles de autenticación.
      1. Selecciona un Tipo de autenticación y, luego, ingresa los detalles relevantes.

        Puedes elegir cualquiera de los siguientes tipos de autenticación:

        • OAuth 2.0
        • Cuenta de servicio

        2. Para comprender cómo configurar estos tipos de autenticación, consulta Configura la autenticación.

      2. Haz clic en Siguiente.
    11. Revisa: Revisa tus detalles de conexión y autenticación.
    12. Haz clic en Crear.

    Configura la autenticación

    Ingresa los detalles según la autenticación que desees usar.

    • OAuth 2.0
      • ID de cliente: Es el ID de cliente necesario para conectarse a tu servicio de backend de Google.
      • Alcances: Selecciona en el menú desplegable los permisos de OAuth 2.0 necesarios. Para ver todos los permisos de OAuth 2.0 admitidos, sigue estos pasos: del servicio de Google que necesitas, consulta la sección correspondiente en la página Alcances de OAuth 2.0 para las APIs de Google.
      • Secreto de cliente: Selecciona el Secret de Secret Manager que contiene la contraseña asociada con el secreto de cliente.
      • Versión del secreto: Selecciona la versión del secreto.
    • Cuenta de servicio

      Selecciona esta opción para autenticarte con la cuenta de servicio que proporcionaste en los pasos anteriores cuando configuraste esta conexión. Asegúrate de tener y proporcionó a la cuenta de servicio los roles y los permisos de IAM relevantes para la autenticación.

      • Alcances: Selecciona los permisos de OAuth 2.0 necesarios en el menú desplegable. Para obtener más información, consulta Permisos de acceso.

    Acciones

    Este conector proporciona una capa de abstracción para los objetos de el servicio de backend conectado. Solo puedes acceder a los objetos del backend a través de esta abstracción. La abstracción se expone como acciones. Un Action es una función de primera clase que está disponible para la integración a través de la interfaz de conector. Una acción te permite realizar cambios en una entidad o entidades y varía de un conector a otro. Sin embargo, es posible que un conector no admita ninguna acción, en cuyo caso la lista Actions estará vacía.

    Usa la conexión del SDK de Admin de Google Workspace en una integración

    Cuando creas la conexión, está disponible en Application Integration. Puedes usar la conexión en una integración a través de la tarea Conectores.

    Obtén ayuda de la Comunidad de Google Cloud

    Puedes publicar tus preguntas y debatir sobre este conector en la comunidad de Google Cloud en Cloud Forums.

    ¿Qué sigue?

    •