SAP Success Factor

Scopo

Cyber Guru offre la possibilità di acquisire informazioni di completamento corsi da parte della popolazione presente in piattaforma, mediante una REST API che restituisce un set di dati idoneo per essere utilizzato dal Learning History Connector di SAP SuccessFactors Learning.

L’automazione dell’acquisizione dei dati forniti da Cyber Guru in SAP SuccessFactors Learning dipende da processi e architetture del cliente e per questo motivo non può essere presidiata da Cyber Guru.

La presente linea guida contiene le direttive e i parametri per l’invocazione del servizio da parte del cliente.

Ambito

Le informazioni si applicano alla piattaforma di Cyber Security Awareness Cyber Guru 2.0.

Prerequisiti

Il cliente deve avere le risorse tecnologiche per poter chiamare REST API con una frequenza
Il cliente deve creare i corsi su SAP SuccessFactors Learning e comunicare i relativi CPNT_ID a Cyber Guru, secondo il seguente schema di esempio (considerare solo le attività facenti parte del pacchetto acquistato):
Nome Attività Cyber Guru
CPNT_ID
Modulo 1 Phishing
999
Modulo 2 Malware
888
Modulo 3 Password
666
etc.

Procedura

Cyber Guru mette a disposizione due REST API :

Get token : https://<...>/protocol/openid-connect/token

Questa API consente di ottenere un token di autorizzazione.

Parametri di chiamata (metodo POST):

client_id : ext-api
client_secret : < fornito da Cyberguru>
grant_types : client_credentials

Get course data : https://<...>/ext/sap/success-factors

che consente di importare un subset di dati da Cyber Guru a SAP Success Factor.

Per poter invocare l’API è necessario fornire il token ottenuto nella precedente API come "Bearer token".

L’API prende in ingresso i seguenti parametri (metodo GET):

suffix (Obbligatorio, String)
cpnt_typ_id (Obbligatorio, String)
cmpl_stat_id (Obbligatorio, String)
separator (Opzionale, Char, default: ',')
es_user_name (Opzionale, String)
start_date (Opzionale, format MON-DD-YYYY)
end_date (Opzionale, format MON-DD-YYYY)
output_mode (Opzionale), 1 file (default), 2 json

Di seguito viene indicato il significato dei parametri:

suffix : tenant id di SAP Success Factor

cpnt_typ_id : id del tipo item

cmpl_stat_id : id dello stato di completamento

separator: il separatore utilizzato in caso di output di tipo file

start_date: data di inizio per cui filtrare il set di risultati; in caso di assenza di start_date verranno restituiti i record dall’inizio

end_date: data di fine per cui filtrare il set di risultati; in caso di assenza di end_date verranno restituiti i record fino alla data odierna

output_mode: modalità di acquisizione della response. Di default viene restituito un file denominato lerninghistory_data_{suffix}.txt, così come richiesto dal Learning History Connector; è possibile modificare questo parametro per ricevere la response in formato JSON.

La response dell’API, nel caso output_mode = 1, è il file lerninghistory_data_{suffix}.txt che può essere direttamente importato su SAP (operazioni di import automatiche possono essere gestite direttamente dal reparto IT del cliente).

Gli attributi contenuti nella response sono tutti gli attributi considerati obbligatori da SAP Success Factor e un sottoinsieme di attributi considerati opzionali da SAP Success Factor (ad esempio non vengono passati attributi opzionali sui quali Cyber Guru non ha dati a disposizione). Di seguito il dettaglio:

Attribute Name	Data Type	Description
STUD_ID	Varchar (90)	Required. Username in Cyber Guru
CPNT_TYP_ID	Varchar (90)	Required. cpnt_typ_id in input parameter
CPNT_ID	Varchar (90)	Required. ID del corso in SAP SF ( * )
CMPL_STAT_ID	Varchar (90)	Required. cmpl_stat_id in input parameter
COMPL_DTE	Date Time	Required. Format MON-DD-YYYY HH24:MI:SS
COMPL_DTE_TIMEZONE	Varchar (90)	Optional
GRADE	Varchar (90)	Optional (Punti dell’utente sull’attività in Cyber Guru)
ES_USER_NAME	Varchar (90)	Optional. es_user_name in input parameter

Nel caso output_mode = 2 , il servizio restituirà un JSON con gli stessi attribute del file. Per esempio:

{
    "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"
        }
    ]
}

Per il corretto funzionamento del processo è necessario che vengano creati su SAP Success Factor i corsi e comunicati a Cyber Guru i CPNT_ID corrispondenti come espresso nei pre-requisiti.

Saranno poi comunicati da Cyber Guru client id e secret per poter ottenere il token e invocare l’API.

Cyber Guru è a disposizione per supportare il cliente nella fase di configurazione e di test su un ambiente di staging e, a valle dell’esito positivo del test, in ambiente di produzione.

Nome Attività Cyber Guru	CPNT_ID
Modulo 1 Phishing	999
Modulo 2 Malware	888
Modulo 3 Password	666
etc.