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 für den Learning History Connector von SAP SuccessFactors Learning geeignet ist.
Die Automatisierung der Datenerfassung, die von Cyber Guru in SAP SuccessFactors Learning 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.
Geltungsbereich
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.
-
Der Kunde muss die Kurse in SAP SuccessFactors Learning erstellen und die entsprechenden CPNT_IDs an Cyber Guru übermitteln, gemäß dem folgenden Beispielschema (nur die im gekauften Paket enthaltenen Aktivitäten berücksichtigen):
Name der Cyber Guru Aktivität
CPNT_ID
Modul 1 Phishing
999
Modul 2 Malware
888
Modul 3 Passwort
666
etc.
Verfahren
Cyber Guru stellt zwei REST-APIs zur Verfügung:
Get token : https://<...>/protocol/openid-connect/token
Diese API ermöglicht es, ein Autorisierungstoken zu erhalten.
Aufrufparameter (POST-Methode):
client_id : ext-api
client_secret : < von Cyberguru bereitgestellt>
grant_types : client_credentials
Get course data : https://<...>/ext/sap/success-factors
Diese API ermöglicht es, einen Datensatz von Cyber Guru zu SAP Success Factor zu importieren.
Um die API aufzurufen, muss das zuvor erhaltene Token als "Bearer Token" bereitgestellt werden.
Die API nimmt die folgenden Parameter entgegen (GET-Methode):
suffix (Erforderlich, String)
cpnt_typ_id (Erforderlich, String)
cmpl_stat_id (Erforderlich, String)
separator (Optional, Char, Standard: ',')
es_user_name (Optional, String)
start_date (Optional, Format MON-DD-YYYY)
end_date (Optional, Format MON-DD-YYYY)
output_mode (Optional), 1 Datei (Standard), 2 JSON
Im Folgenden wird die Bedeutung der Parameter erläutert:
suffix : Tenant-ID von SAP Success Factor
cpnt_typ_id : ID des Item-Typs
cmpl_stat_id : ID des Abschlussstatus
separator: Der Separator, der bei Dateiausgabe verwendet wird
start_date: Startdatum, um den Ergebnissatz zu filtern; bei Fehlen des Startdatums werden die Datensätze von Beginn an zurückgegeben
end_date: Enddatum, um den Ergebnissatz zu filtern; bei Fehlen des Enddatums werden die Datensätze bis zum aktuellen Datum zurückgegeben
output_mode: Modus der Antworterfassung. Standardmäßig wird eine Datei mit dem Namen lerninghistory_data_{suffix}.txt zurückgegeben, wie vom Learning History Connector gefordert; dieser Parameter kann geändert werden, um die Antwort im JSON-Format zu erhalten.
Die Antwort der API, wenn output_mode = 1, ist die Datei lerninghistory_data_{suffix}.txt, die direkt in SAP importiert werden kann (automatische Importvorgänge können direkt von der IT-Abteilung des Kunden verwaltet werden).
Die in der Antwort enthaltenen Attribute sind alle von SAP Success Factor als obligatorisch angesehenen Attribute und ein Teil der als optional angesehenen Attribute von SAP Success Factor (z. B. werden keine optionalen Attribute übermittelt, für die Cyber Guru keine Daten zur Verfügung hat). Im Folgenden die Details:
Attributname |
Datentyp |
Beschreibung |
STUD_ID |
Varchar (90) |
Erforderlich. Benutzername in Cyber Guru |
CPNT_TYP_ID |
Varchar (90) |
Erforderlich. cpnt_typ_id im Eingabeparameter |
CPNT_ID |
Varchar (90) |
Erforderlich. Kurs-ID in SAP SF ( * ) |
CMPL_STAT_ID |
Varchar (90) |
Erforderlich. cmpl_stat_id im Eingabeparameter |
COMPL_DTE |
Date Time |
Erforderlich. Format MON-DD-YYYY HH24:MI:SS |
COMPL_DTE_TIMEZONE |
Varchar (90) |
Optional |
GRADE |
Varchar (90) |
Optional (Punkte des Nutzers bei der Aktivität in Cyber Guru) |
ES_USER_NAME |
Varchar (90) |
Optional. es_user_name im Eingabeparameter |
Im Fall von output_mode = 2 wird der Dienst ein JSON mit denselben Attributen wie die Datei zurückgeben. Zum Beispiel:
{
"status": 200,
"data": [
{
"STUD_ID": "john.doe",
"CPNT_TYP_ID": "986",
"CPNT_ID": "MOD_007",
"CMPL_STAT_ID": "992",
"COMPL_DTE": "Apr-15-2024 14:48:18",
"COMPL_DTE_TIMEZIONE": "",
"GRADE": 4,
"ES_USER_NAME": "Mark Twain"
},
{
"STUD_ID": "mario.rossi",
"CPNT_TYP_ID": "986",
"CPNT_ID": "MOD_002",
"CMPL_STAT_ID": "992",
"COMPL_DTE": "Mar-16-2024 16:53:59",
"COMPL_DTE_TIMEZIONE": "",
"GRADE": 30,
"ES_USER_NAME": "Mark Twain"
},
{
"STUD_ID": "carlos.bianchi",
"CPNT_TYP_ID": "986",
"CPNT_ID": "MOD_004",
"CMPL_STAT_ID": "992",
"COMPL_DTE": "Mar-16-2024 16:53:13",
"COMPL_DTE_TIMEZIONE": "",
"GRADE": 4,
"ES_USER_NAME": "Mark Twain"
}
]
}Für das korrekte Funktionieren des Prozesses ist es notwendig, dass die Kurse in SAP Success Factor erstellt und die entsprechenden CPNT_IDs wie in den Voraussetzungen angegeben an Cyber Guru übermittelt werden.
Cyber Guru wird dann die Client-ID und das Secret bereitstellen, um das Token zu erhalten und die API aufzurufen.
Cyber Guru steht zur Verfügung, um den Kunden bei der Konfiguration und beim Testen in einer Staging-Umgebung zu unterstützen und nach erfolgreichem Test in der Produktionsumgebung.