Recopila registros de UKG
En este documento, se explica cómo transferir registros de UKG a Google Security Operations con Google Cloud Storage V2.
UKG (Ultimate Kronos Group) es una plataforma de administración de capital humano que genera registros de administración de personal, autenticación y seguimiento de auditoría. UKG Pro proporciona una API de REST para el acceso programático a los datos de auditoría.
Antes de comenzar
Asegúrate de cumplir con los siguientes requisitos previos:
- Una instancia de Google SecOps
- Un proyecto de GCP con la API de Cloud Storage habilitada
- Permisos para crear y administrar buckets de GCS
- Permisos para administrar políticas de IAM en buckets de GCS
- Permisos para crear servicios de Cloud Run, temas de Pub/Sub y trabajos de Cloud Scheduler
- Acceso con privilegios a UKG Pro con permisos de administrador y acceso a la API
Crea un bucket de Google Cloud Storage
- Ve a la consola de Google Cloud.
- Selecciona tu proyecto o crea uno nuevo.
- En el menú de navegación, ve a Cloud Storage > Buckets.
- Haz clic en Crear bucket.
Proporciona los siguientes detalles de configuración:
Parámetro de configuración Valor Asigna un nombre a tu bucket Ingresa un nombre único a nivel global (por ejemplo, ukg-logs).Tipo de ubicación Elige una en función de tus necesidades (región, birregional o multirregional). Ubicación Selecciona la ubicación (por ejemplo, us-central1).Clase de almacenamiento Estándar (recomendado para los registros a los que se accede con frecuencia) Control de acceso Uniforme (recomendado) Herramientas de protección Opcional: Habilita el control de versiones de objetos o la política de retención Haz clic en Crear.
Recopila las credenciales de la API de UKG Pro
Obtén credenciales de la API
- Accede al portal de administración de UKG Pro.
- Ve a Menú > Administración > Configuración del sistema > Servicios web.
- Crea o busca tus credenciales de API:
- Clave de API (US-Customer-Api-Key): Es la clave de API del cliente para la autenticación.
- Nombre de usuario de la cuenta de servicio: Es el nombre de usuario de la cuenta de servicio.
- Contraseña de la cuenta de servicio: Es la contraseña de la cuenta de servicio.
Anota la URL del host de servicio (por ejemplo,
https://SERVICE_HOST).
Verifica los permisos
Para verificar que las credenciales de la API tengan el acceso requerido, sigue estos pasos:
- Accede al portal de administración de UKG Pro.
- Ve a Menú > Administración > Configuración del sistema > Seguridad > Registro de auditoría.
- Verifica que puedas ver los registros de auditoría.
- Si no puedes acceder a los datos de auditoría, comunícate con tu administrador de UKG Pro para que te otorgue los permisos necesarios.
Prueba el acceso a la API
Prueba tus credenciales antes de continuar con la integración:
# Replace with your actual credentials ACCESS_TOKEN="your-access-token" API_KEY="your-api-key" SERVICE_HOST="your-service-host" # Test API access - fetch audit logs curl -v -H "Authorization: Bearer ${ACCESS_TOKEN}" \ -H "US-Customer-Api-Key: ${API_KEY}" \ "https://${SERVICE_HOST}/personnel/v1/audit-logs?startDate=2024-01-01&endDate=2024-01-02"
Crea una cuenta de servicio para la función de Cloud Run
La función de Cloud Run necesita una cuenta de servicio con permisos para escribir en el bucket de GCS y que Pub/Sub la invoque.
Crear cuenta de servicio
- En Google Cloud Console, ve a IAM y administración > Cuentas de servicio.
- Haz clic en Crear cuenta de servicio.
- Proporciona los siguientes detalles de configuración:
- Nombre de la cuenta de servicio: Ingresa
ukg-collector-sa. - Descripción de la cuenta de servicio: Ingresa
Service account for Cloud Run function to collect UKG logs.
- Nombre de la cuenta de servicio: Ingresa
- Haz clic en Crear y continuar.
- En la sección Otorga acceso al proyecto a esta cuenta de servicio, agrega los siguientes roles:
- Haz clic en Selecciona un rol.
- Busca y selecciona Administrador de objetos de Storage.
- Haz clic en + Agregar otro rol.
- Busca y selecciona Invocador de Cloud Run.
- Haz clic en + Agregar otro rol.
- Busca y selecciona Invocador de Cloud Functions.
- Haz clic en Continuar.
- Haz clic en Listo.
Estos roles son necesarios para lo siguiente:
- Administrador de objetos de Storage: Escribe registros en el bucket de GCS y administra archivos de estado
- Invocador de Cloud Run: Permite que Pub/Sub invoque la función
- Invocador de Cloud Functions: Permite la invocación de funciones
Otorga permisos de IAM en el bucket de GCS
Otorga permisos de escritura a la cuenta de servicio en el bucket de GCS:
- Ve a Cloud Storage > Buckets.
- Haz clic en el nombre de tu bucket (por ejemplo,
ukg-logs). - Ve a la pestaña Permisos.
- Haz clic en Otorgar acceso.
- Proporciona los siguientes detalles de configuración:
- Agregar entidades: Ingresa el correo electrónico de la cuenta de servicio (por ejemplo,
ukg-collector-sa@your-project.iam.gserviceaccount.com). - Asignar roles: Selecciona Administrador de objetos de Storage.
- Agregar entidades: Ingresa el correo electrónico de la cuenta de servicio (por ejemplo,
- Haz clic en Guardar.
Crea un tema de Pub/Sub
Crea un tema de Pub/Sub en el que Cloud Scheduler publicará y al que se suscribirá la función de Cloud Run.
- En Google Cloud Console, ve a Pub/Sub > Temas.
- Haz clic en Crear tema.
- Proporciona los siguientes detalles de configuración:
- ID del tema: Ingresa
ukg-trigger. - Deja el resto de la configuración con sus valores predeterminados.
- ID del tema: Ingresa
- Haz clic en Crear.
Crea una función de Cloud Run para recopilar registros
La función de Cloud Run se activará con mensajes de Pub/Sub de Cloud Scheduler para recuperar registros de la API de UKG Pro y escribirlos en GCS.
- En Google Cloud Console, ve a Cloud Run.
- Haz clic en Crear servicio.
- Selecciona Función (usa un editor directo para crear una función).
En la sección Configurar, proporciona los siguientes detalles de configuración:
Parámetro de configuración Valor Nombre del servicio ukg-collectorRegión Selecciona la región que coincida con tu bucket de GCS (por ejemplo, us-central1).Tiempo de ejecución Selecciona Python 3.12 o una versión posterior. En la sección Activador (opcional), haz lo siguiente:
- Haz clic en + Agregar activador.
- Selecciona Cloud Pub/Sub.
- En Selecciona un tema de Cloud Pub/Sub, elige el tema
ukg-trigger. - Haz clic en Guardar.
En la sección Autenticación, haz lo siguiente:
- Selecciona Necesita autenticación.
- Verifica la Administración de identidades y accesos (IAM).
Desplázate hacia abajo y expande Contenedores, redes y seguridad.
Ve a la pestaña Seguridad:
- Cuenta de servicio: Selecciona la cuenta de servicio
ukg-collector-sa.
- Cuenta de servicio: Selecciona la cuenta de servicio
Ve a la pestaña Contenedores:
- Haz clic en Variables y secretos.
- Haz clic en + Agregar variable para cada variable de entorno:
Nombre de la variable Valor de ejemplo Descripción GCS_BUCKETukg-logsNombre del bucket de GCS GCS_PREFIXukgPrefijo para los archivos de registro STATE_KEYukg/state.jsonRuta de acceso al archivo de estado SERVICE_HOSTyour-service-hostURL del host de servicio de UKG Pro UKG_USERNAMEyour-service-usernameNombre de usuario de la cuenta de servicio UKG_PASSWORDyour-service-passwordContraseña de la cuenta de servicio UKG_API_KEYyour-api-keyClave de API del cliente MAX_RECORDS10000Cantidad máxima de registros por ejecución PAGE_SIZE100Registros por página LOOKBACK_HOURS24Período de visualización inicial En la pestaña Variables y secretos, desplázate hacia abajo hasta Solicitudes:
- Tiempo de espera de la solicitud: Ingresa
600segundos (10 minutos).
- Tiempo de espera de la solicitud: Ingresa
Ve a la pestaña Configuración en Contenedores:
- En la sección Recursos, haz lo siguiente:
- Memoria: Selecciona 512 MiB o más.
- CPU: Selecciona 1.
- En la sección Recursos, haz lo siguiente:
En la sección Escalamiento de revisión, haz lo siguiente:
- Cantidad mínima de instancias: Ingresa
0. - Cantidad máxima de instancias: Ingresa
100(o ajusta según la carga esperada).
- Cantidad mínima de instancias: Ingresa
Haz clic en Crear.
Espera a que se cree el servicio (de 1 a 2 minutos).
Después de crear el servicio, se abrirá automáticamente el editor de código intercalado.
Agregar el código de función
- Ingresa main en Punto de entrada de la función.
En el editor de código intercalado, crea dos archivos:
- Primer archivo: main.py:
import functions_framework from google.cloud import storage import json import os import urllib3 from datetime import datetime, timezone, timedelta import time import base64 # Initialize HTTP client with timeouts http = urllib3.PoolManager( timeout=urllib3.Timeout(connect=5.0, read=30.0), retries=False, ) # Initialize Storage client storage_client = storage.Client() # Environment variables GCS_BUCKET = os.environ.get('GCS_BUCKET') GCS_PREFIX = os.environ.get('GCS_PREFIX', 'ukg') STATE_KEY = os.environ.get('STATE_KEY', 'ukg/state.json') SERVICE_HOST = os.environ.get('SERVICE_HOST', '').rstrip('/') UKG_USERNAME = os.environ.get('UKG_USERNAME', '') UKG_PASSWORD = os.environ.get('UKG_PASSWORD', '') UKG_API_KEY = os.environ.get('UKG_API_KEY', '') MAX_RECORDS = int(os.environ.get('MAX_RECORDS', '10000')) PAGE_SIZE = int(os.environ.get('PAGE_SIZE', '100')) LOOKBACK_HOURS = int(os.environ.get('LOOKBACK_HOURS', '24')) def parse_datetime(value: str) -> datetime: """Parse ISO datetime string to datetime object.""" if value.endswith("Z"): value = value[:-1] + "+00:00" return datetime.fromisoformat(value) def get_token(): """Get OAuth 2.0 access token from UKG Pro.""" token_url = f"https://{SERVICE_HOST}/authentication/token" auth_string = f"{UKG_USERNAME}:{UKG_PASSWORD}" auth_bytes = auth_string.encode('utf-8') auth_b64 = base64.b64encode(auth_bytes).decode('utf-8') headers = { 'Authorization': f'Basic {auth_b64}', 'US-Customer-Api-Key': UKG_API_KEY, 'Content-Type': 'application/x-www-form-urlencoded', 'Accept': 'application/json' } body = 'grant_type=client_credentials' backoff = 1.0 max_retries = 3 for attempt in range(max_retries): response = http.request('POST', token_url, body=body.encode('utf-8'), headers=headers) if response.status == 429: retry_after = int(response.headers.get('Retry-After', str(int(backoff)))) print(f"Rate limited (429) on token request. Retrying after {retry_after}s...") time.sleep(retry_after) backoff = min(backoff * 2, 30.0) continue if response.status != 200: raise RuntimeError(f"Failed to get access token: {response.status} - {response.data.decode('utf-8')}") data = json.loads(response.data.decode('utf-8')) return data['access_token'] raise RuntimeError(f"Failed to get token after {max_retries} retries due to rate limiting") @functions_framework.cloud_event def main(cloud_event): """ Cloud Run function triggered by Pub/Sub to fetch UKG logs and write to GCS. Args: cloud_event: CloudEvent object containing Pub/Sub message """ if not all([GCS_BUCKET, SERVICE_HOST, UKG_USERNAME, UKG_PASSWORD, UKG_API_KEY]): print('Error: Missing required environment variables') return try: bucket = storage_client.bucket(GCS_BUCKET) # Load state state = load_state(bucket, STATE_KEY) # Determine time window now = datetime.now(timezone.utc) last_time = None if isinstance(state, dict) and state.get("last_event_time"): try: last_time = parse_datetime(state["last_event_time"]) last_time = last_time - timedelta(minutes=2) except Exception as e: print(f"Warning: Could not parse last_event_time: {e}") if last_time is None: last_time = now - timedelta(hours=LOOKBACK_HOURS) print(f"Fetching logs from {last_time.isoformat()} to {now.isoformat()}") # Get access token token = get_token() # Fetch logs records, newest_event_time = fetch_logs( token=token, start_time=last_time, end_time=now, page_size=PAGE_SIZE, max_records=MAX_RECORDS, ) if not records: print("No new log records found.") save_state(bucket, STATE_KEY, now.isoformat()) return # Write to GCS as NDJSON timestamp = now.strftime('%Y%m%d_%H%M%S') object_key = f"{GCS_PREFIX}/logs_{timestamp}.ndjson" blob = bucket.blob(object_key) ndjson = '\n'.join([json.dumps(record, ensure_ascii=False) for record in records]) + '\n' blob.upload_from_string(ndjson, content_type='application/x-ndjson') print(f"Wrote {len(records)} records to gs://{GCS_BUCKET}/{object_key}") if newest_event_time: save_state(bucket, STATE_KEY, newest_event_time) else: save_state(bucket, STATE_KEY, now.isoformat()) print(f"Successfully processed {len(records)} records") except Exception as e: print(f'Error processing logs: {str(e)}') raise def load_state(bucket, key): """Load state from GCS.""" try: blob = bucket.blob(key) if blob.exists(): state_data = blob.download_as_text() return json.loads(state_data) except Exception as e: print(f"Warning: Could not load state: {e}") return {} def save_state(bucket, key, last_event_time_iso: str): """Save the last event timestamp to GCS state file.""" try: state = {'last_event_time': last_event_time_iso} blob = bucket.blob(key) blob.upload_from_string( json.dumps(state, indent=2), content_type='application/json' ) print(f"Saved state: last_event_time={last_event_time_iso}") except Exception as e: print(f"Warning: Could not save state: {e}") def fetch_logs(token: str, start_time: datetime, end_time: datetime, page_size: int, max_records: int): """ Fetch audit logs from UKG Pro API with pagination and rate limiting. Args: token: OAuth 2.0 access token start_time: Start time for log query end_time: End time for log query page_size: Number of records per page max_records: Maximum total records to fetch Returns: Tuple of (records list, newest_event_time ISO string) """ endpoint = f"https://{SERVICE_HOST}/personnel/v1/audit-logs" headers = { 'Authorization': f'Bearer {token}', 'US-Customer-Api-Key': UKG_API_KEY, 'Accept': 'application/json', 'User-Agent': 'GoogleSecOps-UKGCollector/1.0' } records = [] newest_time = None page_num = 0 backoff = 1.0 page = 1 start_date = start_time.strftime('%Y-%m-%d') end_date = end_time.strftime('%Y-%m-%d') while True: page_num += 1 if len(records) >= max_records: print(f"Reached max_records limit ({max_records})") break url = f"{endpoint}?startDate={start_date}&endDate={end_date}&page={page}&per_page={page_size}" try: response = http.request('GET', url, headers=headers) if response.status == 429: retry_after = int(response.headers.get('Retry-After', str(int(backoff)))) print(f"Rate limited (429). Retrying after {retry_after}s...") time.sleep(retry_after) backoff = min(backoff * 2, 30.0) continue backoff = 1.0 if response.status != 200: print(f"HTTP Error: {response.status}") response_text = response.data.decode('utf-8') print(f"Response body: {response_text}") return [], None data = json.loads(response.data.decode('utf-8')) # UKG may return results in different formats if isinstance(data, list): page_results = data else: page_results = data.get('data', data.get('results', data.get('auditLogs', []))) if not page_results: print(f"No more results (empty page)") break print(f"Page {page_num}: Retrieved {len(page_results)} events") records.extend(page_results) # Track newest event time for event in page_results: try: event_time = event.get('auditDate') or event.get('dateTime') or event.get('timestamp') if event_time: if newest_time is None or parse_datetime(event_time) > parse_datetime(newest_time): newest_time = event_time except Exception as e: print(f"Warning: Could not parse event time: {e}") if len(page_results) < page_size: print(f"Reached last page (size={len(page_results)} < limit={page_size})") break page += 1 except Exception as e: print(f"Error fetching logs: {e}") return [], None print(f"Retrieved {len(records)} total records from {page_num} pages") return records, newest_time- Segundo archivo: requirements.txt:
functions-framework==3.* google-cloud-storage==2.* urllib3>=2.0.0Haz clic en Implementar para guardar y, luego, implementar la función.
Espera a que se complete la implementación (de 2 a 3 minutos).
Crea un trabajo de Cloud Scheduler
Cloud Scheduler publicará mensajes en el tema de Pub/Sub a intervalos regulares, lo que activará la función de Cloud Run.
- En Google Cloud Console, ve a Cloud Scheduler.
- Haz clic en Crear trabajo.
Proporciona los siguientes detalles de configuración:
Parámetro de configuración Valor Nombre ukg-collector-hourlyRegión Selecciona la misma región que la función de Cloud Run Frecuencia 0 * * * *(cada hora, en punto)Zona horaria Selecciona la zona horaria (se recomienda UTC) Tipo de objetivo Pub/Sub Tema Selecciona el tema ukg-trigger.Cuerpo del mensaje {}(objeto JSON vacío)Haz clic en Crear.
Opciones de frecuencia de programación
Elige la frecuencia según el volumen de registros y los requisitos de latencia:
| Frecuencia | Expresión cron | Caso de uso |
|---|---|---|
| Cada 5 minutos | */5 * * * * |
Alto volumen y baja latencia |
| Cada 15 minutos | */15 * * * * |
Volumen medio |
| Cada 1 hora | 0 * * * * |
Estándar (recomendado) |
| Cada 6 horas | 0 */6 * * * |
Procesamiento por lotes de bajo volumen |
| Diario | 0 0 * * * |
Recopilación de datos históricos |
Prueba la integración
- En la consola de Cloud Scheduler, busca tu trabajo (
ukg-collector-hourly). - Haz clic en Forzar ejecución para activar la tarea de forma manual.
- Espera unos segundos y ve a Cloud Run > Servicios > ukg-collector > Registros.
Verifica que la función se haya ejecutado correctamente. Busca lo siguiente:
Fetching logs from YYYY-MM-DDTHH:MM:SS+00:00 to YYYY-MM-DDTHH:MM:SS+00:00 Page 1: Retrieved X events Wrote X records to gs://ukg-logs/ukg/logs_YYYYMMDD_HHMMSS.ndjson Successfully processed X recordsVerifica el bucket de GCS (
ukg-logs) para confirmar que se hayan escrito los registros.
Si ves errores en los registros, haz lo siguiente:
- HTTP 401: Verifica las credenciales de la API en las variables de entorno.
- HTTP 403: Verifica que la cuenta de servicio tenga los permisos necesarios en UKG Pro.
- HTTP 429: Límite de frecuencia: La función volverá a intentarlo automáticamente con retirada
- No se pudo obtener el token de acceso: Verifica que
SERVICE_HOST,UKG_USERNAME,UKG_PASSWORDyUKG_API_KEYsean correctos.
Configura un feed en Google SecOps para transferir registros de UKG
- Ve a Configuración > Administración de datos > Feeds. Si estás en una plataforma solo de SIEM, ve a Configuración > Feeds.
- Haz clic en Agregar feed nuevo.
- Haz clic en Configura un feed único.
- En el campo Nombre del feed, ingresa un nombre para el feed (por ejemplo,
UKG Logs). - Selecciona Google Cloud Storage V2 como el Tipo de fuente.
- Selecciona UKG como el Tipo de registro.
Haz clic en Obtener cuenta de servicio. Se mostrará un correo electrónico único de la cuenta de servicio, por ejemplo:
chronicle-12345678@chronicle-gcp-prod.iam.gserviceaccount.comCopia esta dirección de correo electrónico. la usarás en el próximo paso.
Haz clic en Siguiente.
Especifica valores para los siguientes parámetros de entrada:
URL del bucket de almacenamiento: Ingresa el URI del bucket de GCS con la ruta de acceso del prefijo:
gs://ukg-logs/ukg/- Reemplaza:
ukg-logs: Es el nombre de tu bucket de GCS.ukg: Es el prefijo o la ruta de acceso de la carpeta opcional en la que se almacenan los registros (deja este campo vacío para la raíz).
- Reemplaza:
Opción de eliminación del código fuente: Selecciona la opción de eliminación según tu preferencia:
- Nunca: Nunca borra ningún archivo después de las transferencias (se recomienda para las pruebas).
- Borrar archivos transferidos: Borra los archivos después de que se transfirieron correctamente.
Borrar los archivos transferidos y los directorios vacíos: Borra los archivos y los directorios vacíos después de que se transfirieron correctamente.
Antigüedad máxima del archivo: Incluye los archivos modificados en la última cantidad de días (el valor predeterminado es 180 días).
Espacio de nombres del recurso: Es el espacio de nombres del recurso.
Etiquetas de transferencia: Es la etiqueta que se aplicará a los eventos de este feed.
Haz clic en Siguiente.
Revisa la configuración de tu feed de noticias nuevo en la pantalla Finalizar y, luego, haz clic en Enviar.
Otorga permisos de IAM a la cuenta de servicio de Google SecOps
La cuenta de servicio de Google SecOps necesita el rol de visualizador de objetos de Storage en tu bucket de GCS.
- Ve a Cloud Storage > Buckets.
- Haz clic en el nombre de tu bucket (
ukg-logs). - Ve a la pestaña Permisos.
- Haz clic en Otorgar acceso.
- Proporciona los siguientes detalles de configuración:
- Agregar entidades: Pega el correo electrónico de la cuenta de servicio de Google SecOps.
- Asigna roles: Selecciona Visualizador de objetos de Storage.
Haz clic en Guardar.
Tabla de asignación de UDM
| Campo de registro | Asignación de UDM | Lógica |
|---|---|---|
| integrationUserKey, userStatus | entity.user.attribute.labels | Se combinan como etiquetas de par clave-valor con la clave establecida en el nombre del campo y el valor del campo |
| userName | entity.user.email_addresses | Se combina en un array si coincide con la regex de correo electrónico |
| employeeId | entity.user.employee_id | El valor se copia directamente si no está vacío |
| userLastLogonDate | entity.user.last_login_time | Se convirtió en marca de tiempo con la coincidencia de fecha con los formatos ISO8601 o yyyy-MM-ddTHH:mm:ss.SS |
| userLastPasswordChangeDate | entity.user.last_password_change_time | Se convirtió en marca de tiempo con la coincidencia de fecha con los formatos yyyy-MM-ddTHH:mm:ss.SSS o ISO8601 |
| userid | entity.user.product_object_id | Se convirtió en cadena |
| fullName | entity.user.user_display_name | El valor se copia directamente. |
| userid | entity.user.userid | Se convirtió en cadena |
| has_user | metadata.entity_type | Se establece en "USER" si has_user == "true"; de lo contrario, se establece en "UNKNOWN_ENTITYTYPE". |
Registro de cambios
Consulta el registro de cambios de este analizador
¿Necesitas más ayuda? Obtén respuestas de miembros de la comunidad y profesionales de Google SecOps.