Purpose
Cyber Guru offers the ability to obtain course completion information from the users on the platform through a REST API that provides a data set suitable for use by Workday.
The automation of data acquisition provided by Cyber Guru in Workday depends on the client's processes and architectures and therefore cannot be managed by Cyber Guru.
This guideline contains the directives and parameters for the client to invoke the service.
Scope
The information applies to the Cyber Security Awareness platform Cyber Guru 2.0.
Prerequisites
The client must have the technological resources to call REST API at a frequency
Procedure
Cyber Guru provides two REST APIs:
Get token: https://login.platform.cyberguru.eu/realms/{TENANT}/protocol/openid-connect/token
This API allows you to obtain an authorization token.
Call parameters (POST method):
client_id: ext-api
client_secret: < provided by Cyberguru>
grant_types: client_credentials
Get course data: https://<...>/ext/training/work-day
which allows importing a subset of data from Cyber Guru to Workday.
To invoke the API, you need to provide the token obtained from the previous API as a "Bearer token".
The API accepts the following parameters (GET method):
start_date (Optional, format YYYY-MM-DD)
end_date (Optional, format YYYY-MM-DD)
lang (Optional)
The API returns the following attributes in JSON format:
Attribute |
Description |
Learning_Content_Reference |
Module name in the specified language |
User's email |
|
Registered_Date |
Release date (format: YYYY-MM-DD) when the user started the course |
Learning_Enrollment_Completion_Date |
Date when the user completed the course for the first time (format YYYY-MM-DD) |
Learning_Grade_Reference |
'PASS' |
Below is a sample JSON response:
{
"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 is available to support the client during the configuration and testing phase in a staging environment and, following a successful test, in a production environment.