Propósito
Cyber Guru ofrece la posibilidad de adquirir información sobre la finalización de cursos por parte de la población presente en la plataforma, mediante una REST API que devuelve un conjunto de datos adecuado para ser utilizado por Workday.
La automatización de la adquisición de los datos proporcionados por Cyber Guru en Workday depende de los procesos y arquitecturas del cliente y, por este motivo, no puede ser supervisada por Cyber Guru.
Esta guía contiene las directrices y los parámetros para la invocación del servicio por parte del cliente.
Ámbito
La información se aplica a la plataforma de Concienciación en Ciberseguridad Cyber Guru 2.0.
Requisitos previos
El cliente debe tener los recursos tecnológicos para poder llamar a la REST API con una frecuencia
Procedimiento
Cyber Guru pone a disposición dos REST API:
Obtener token: https://login.platform.cyberguru.eu/realms/{TENANT}/protocol/openid-connect/token
Esta API permite obtener un token de autorización.
Parámetros de llamada (método POST):
client_id: ext-api
client_secret: < proporcionado por Cyberguru>
grant_types: client_credentials
Obtener datos del curso: https://<...>/ext/training/work-day
que permite importar un subconjunto de datos de Cyber Guru a Workday.
Para poder invocar la API es necesario proporcionar el token obtenido en la API anterior como "Bearer token".
La API recibe los siguientes parámetros de entrada (método GET):
start_date (Opcional, formato YYYY-MM-DD)
end_date (Opcional, formato YYYY-MM-DD)
lang (Opcional)
La API devuelve los siguientes atributos en formato json:
Atributo |
Descripción |
Learning_Content_Reference |
Nombre del módulo en el idioma especificado |
Email del usuario |
|
Registered_Date |
Fecha de inicio (formato: YYYY-MM-DD) en la que el usuario comenzó el curso |
Learning_Enrollment_Completion_Date |
Fecha en la que el usuario completó el curso por primera vez (formato YYYY-MM-DD) |
Learning_Grade_Reference |
'PASS' |
A continuación, el json de ejemplo de la respuesta:
{
"status": 200,
"data": [
{
"Learning_Content_Reference": "M01",
"Registered_Date": "2021-08-06",
"Learning_Enrollment_Completion_Date": "2024-03-05",
"Learning_Grade_Reference": "PASS",
"Email": "name-test-1@mymail.com"
},
{
"Learning_Content_Reference": "M02",
"Registered_Date": "2021-08-21",
"Learning_Enrollment_Completion_Date": "2024-03-05",
"Learning_Grade_Reference": "PASS",
"Email": "name-test-2@mymail.com"
},
{
"Learning_Content_Reference": "N04",
"Registered_Date": "2023/08/02",
"Learning_Enrollment_Completion_Date": "2024-03-20",
"Learning_Grade_Reference": "PASS",
"Email": "name-test-3@mymail.com"
},
{
"Learning_Content_Reference": "Q09",
"Registered_Date": "2021/08/21",
"Learning_Enrollment_Completion_Date": "2023-08-23",
"Learning_Grade_Reference": "PASS",
"Email": "name-test-4@mymail.com"
}
]
}Cyber Guru está disponible para apoyar al cliente en la fase de configuración y prueba en un entorno de staging y, tras el resultado positivo de la prueba, en un entorno de producción.