Zweck
Cyber Guru bietet die Möglichkeit, Kursabschlussinformationen der auf der Plattform vorhandenen Nutzer über eine REST-API zu erhalten, die einen Datensatz zurückgibt, der vom Kunden in eigenen LMS oder anderen Plattformen verwendet werden kann.
Die Automatisierung der Datenerfassung, die von Cyber Guru bereitgestellt wird, hängt von den Prozessen und Architekturen des Kunden ab und kann daher nicht von Cyber Guru überwacht werden.
Diese Richtlinie enthält die Anweisungen und Parameter für die Nutzung des Dienstes durch den Kunden.
Anwendungsbereich
Die Informationen gelten für die Plattform Cyber Security Awareness Cyber Guru 2.0.
Voraussetzungen
-
Der Kunde muss über die technischen Ressourcen verfügen, um REST-APIs regelmäßig aufrufen zu können.
Verfahren
Cyber Guru stellt zwei REST-APIs zur Verfügung:
Get token: https://login.platform.cyberguru.eu/realms/{TENANT}/protocol/openid-connect/token
Diese API ermöglicht es, ein Autorisierungstoken zu erhalten.
Aufrufparameter (POST-Methode):
-
client_id: ext-api
-
client_secret:
-
grant_types: client_credentials
Get course data: https://<...>/</...>ext/training/completed-user-activities
Diese API ermöglicht es, einen Teil der Daten von Cyber Guru nach Workday zu importieren.
Um die API aufzurufen, muss das zuvor erhaltene Token als "Bearer Token" bereitgestellt werden.
Die API akzeptiert die folgenden Parameter (GET-Methode):
-
start_date (Optional, Format YYYY-MM-DD)
-
end_date (Optional, Format YYYY-MM-DD)
-
lang (Optional)
Die API gibt die folgenden Attribute im JSON-Format zurück:
|
Attribut |
Beschreibung |
|
Firstname |
Vorname des Nutzers |
|
Lastname |
Nachname des Nutzers |
|
|
Email des Nutzers |
|
Country |
Herkunftsland des Nutzers |
|
Team |
Teamzugehörigkeit des Nutzers |
|
Learning_Activity |
Name des Moduls in der angegebenen Sprache (oder in der Standardsprache des Fallbacks von Localization) |
|
Availability_Date |
Veröffentlichungsdatum, d.h. das Datum, an dem der Kurs freigegeben wurde (Format YYYY-MM-DD) |
|
Start_date |
Datum, an dem der Nutzer den Kurs begonnen hat (Format YYYY-MM-DD) |
|
Time_Spent |
Zeit im Format hh:mm:ss, die der Nutzer für den Kurs aufgewendet/abgeschlossen hat |
|
Completion_Date |
Datum, an dem der Nutzer den Kurs erstmals abgeschlossen hat (Format YYYY-MM-DD) |
|
Badge |
Boolesches Feld, das 1 ist, wenn der Nutzer ein Abzeichen erhalten hat, sonst 0 |
Nachfolgend ein Beispiel-JSON der Antwort:
{
"status": 200,
"data": [
{
"Firstname": "John",
"Lastname" : "Doe",
"Email": "name-test-1@mymail.com",
"Country": "UK",
"Team": "Red Ribbon",
"Learning_Activity": "Password",
"Registered_Date": "2024-03-06",
"Start_Date": "2024-03-17",
"Time_Spent": "00:22:35",
"Points": 12,
"Completion_Date": "2024-03-25",
"Badge": 1
},
{
"Firstname": "Donald",
"Lastname" : "Duck",
"Email": "name-test-2@mymail.com",
"Country": "U.S.A.",
"Team": "Duck Tales",
"Learning_Activity": "Phishing",
"Registered_Date": "2024-04-06",
"Start_Date": "2024-04-17",
"Time_Spent": "00:25:40",
"Points": 12,
"Completion_Date": "2024-04-29",
"Badge": 1
}
]
}
Cyber Guru steht zur Verfügung, um den Kunden bei der Konfiguration und dem Testen in einer Staging-Umgebung zu unterstützen und nach erfolgreichem Test in der Produktionsumgebung.