exportSecurityAudit

Supportato nell'API v20 +

Categoria	Recupero dei dati
Descrizione	Restituisce un report di tutti gli eventi di sicurezza in un intervallo di tempo specificato, filtrabile per tipo di evento. Gli eventi di sicurezza includono tentativi di accesso non riusciti, modifiche della password, blocco dell'account, creazione di account e altre informazioni relative alla sicurezza. Se non viene richiesto alcun intervallo di tempo, vengono restituiti tutti gli eventi delle ultime 24 ore. Gli eventi di sicurezza registrati dal registro di controllo si basano su NIST 800-53. Adaptive Planning conserva solo 30 giorni di dati di controllo di sicurezza.
Autorizzazioni necessarie per richiamare	Amministratore
Parametri obbligatori su richiesta	Credenziali

La richiesta di questo metodo contiene un tag delle credenziali per identificare e autorizzare l'utente chiamante e un tag di inclusione che identifica l'attore e l'intervallo di tempo per cui recuperare gli eventi di sicurezza. Una volta verificato, il metodo restituisce un documento XML che descrive tutti gli eventi di sicurezza nell'intervallo di tempo specificato, filtrabile per tipo di evento.

Formato richiesta


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportSecurityAudit" callerName="a string that identifies your client application">
 <credentials login="sampleuser@company.com" password="my_pwd"/>
 <include actor="stevec@greenco.com" dateTimeFrom="2019-07-30 00:00:00" dateTimeTo="2019-07-30 11:59:59"/>
</call>

elemento credenziali
Nome tag		credenziali
Descrizione		Tutte le chiamate API devono contenere un singolo elemento di credenziali per identificare l'utente che richiama l'API. La chiamata API viene quindi eseguita come utente (qualsiasi audit trail o storico delle azioni nel sistema mostrerà che l'azione è stata eseguita dall'utente) e pertanto l'utente deve disporre delle autorizzazioni necessarie per eseguire l'azione affinché la chiamata API avere esito positivo.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
accedere	S	Il nome di accesso dell'utente che richiama il metodo API. L'utente deve disporre delle autorizzazioni necessarie per richiamare il metodo.	sampleuser@company.com
password	S	La password dell'utente che richiama il metodo API.	my_password
Contenuto dell'elemento
nessuno

elemento include
Nome tag		includere
Descrizione
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
attore	N	Il nome utente di cui si desidera recuperare gli eventi di sicurezza. Restituisce eventi per tutti gli utenti quando l'attore non è incluso.	stevec@greenco.com
dateTimeFrom	N	L'inizio dell'intervallo di tempo in formato compatibile con ISO-8601 ( YYYY-MM-DDTHH:MM:SS ) in UTC per gli eventi di sicurezza che si desidera recuperare.	2019-07-30 00:00:00
dateTimeTo	N	La fine dell'intervallo di tempo in formato compatibile con ISO-8601 ( YYYY-MM-DDTHH:MM:SS ) in UTC per gli eventi di sicurezza che si desidera recuperare.	30/07/2019 11:59:59
Contenuto dell'elemento
nessuno

Formato risposta


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
 <output>
     <audit>
        <event timestamp="2019-07-30 01:59:48.7781" action="SUC" actor="475245454E434F000000000001000004" version="20" interface="" object="User - 475245454E434F000000000001000004" outcome="0" context="" />
        <event timestamp="2019-07-30 01:59:48.9822" action="SUC" actor="475245454E434F000000000001000004" version="20" interface="" object="User - 475245454E434F000000000001000004" outcome="0" context="" />
        <event timestamp="2019-07-30 02:01:29.115" action="SUC" actor="475245454E434F000000000001000004" version="20" interface="" object="User - 475245454E434F000000000001000004" outcome="0" context="" />
        <event timestamp="2019-07-30 02:02:03.0594" action="SUC" actor="475245454E434F000000000001000004" version="20" interface="" object="User - 475245454E434F000000000001000004" outcome="0" context="" />
        <event timestamp="2019-07-30 02:06:35.8937" action="SUC" actor="475245454E434F000000000001000004" version="20" interface="" object="User - 475245454E434F000000000001000004" outcome="0" context="" />
        <event timestamp="2019-07-30 02:06:36.0589" action="SUC" actor="475245454E434F000000000001000004" version="20" interface="" object="User - 475245454E434F000000000001000004" outcome="0" context="" />
        <event timestamp="2019-07-30 02:06:36.1219" action="SUC" actor="475245454E434F000000000001000004" version="20" interface="" object="User - 475245454E434F000000000001000004" outcome="0" context="" />
        <event timestamp="2019-07-30 02:06:59.8724" action="SUC" actor="475245454E434F000000000001000004" version="20" interface="" object="User - 475245454E434F000000000001000004" outcome="0" context="" />
        <event timestamp="2019-07-30 02:07:36.5505" action="SUC" actor="475245454E434F000000000001000004" version="20" interface="" object="User - 475245454E434F000000000001000004" outcome="0" context="" />
        <event timestamp="2019-07-30 02:07:37.8862" action="SUC" actor="475245454E434F000000000001000004" version="20" interface="" object="User - 475245454E434F000000000001000004" outcome="0" context="" />
        <event timestamp="2019-07-30 02:08:06.7037" action="SUC" actor="475245454E434F000000000001000004" version="20" interface="" object="User - 475245454E434F000000000001000004" outcome="0" context="" />
        <event timestamp="2019-07-30 02:08:10.4557" action="SUC" actor="475245454E434F000000000001000004" version="20" interface="" object="User - 475245454E434F000000000001000004" outcome="0" context="" />
        <event timestamp="2019-07-30 02:08:14.8878" action="SUC" actor="475245454E434F000000000001000004" version="20" interface="" object="User - 475245454E434F000000000001000004" outcome="0" context="" />
     </audit>  
 </output>
</response>

elemento di risposta
Nome tag		risposta
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
successo	S	Vero o falso, a indicare se la chiamata API è riuscita o meno. Anche le chiamate riuscite possono contenere messaggi di avviso nella risposta.	true
obsoleto	N	Se presente nel tag di risposta e impostato su true, questo attributo indica che la versione del metodo o dell'API richiamata è diventata obsoleta ed è ufficialmente obsoleta da Adaptive Planning . Sebbene continui a funzionare in questo momento, potrebbe cessare di funzionare in breve tempo. In genere, questo attributo non è presente.	falso
Contenuto dell'elemento
Un singolo elemento di messaggi facoltativo ed esattamente un elemento di output obbligatorio.

elemento di output
Nome tag	output
Attributi dell'elemento
(nessuno)
Contenuto dell'elemento
Un singolo elemento di controllo. Questo wrapper di output è standard in tutte le risposte API e racchiude l'output valido di qualsiasi chiamata API riuscita.

audit element
Nome tag		controllo
Descrizione		Una raccolta di eventi di sicurezza.
Attributi dell'elemento
(nessuno)
Contenuto dell'elemento
Uno o più elementi evento.

elemento evento
Nome tag		evento
Descrizione		Un evento di sicurezza
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
timestamp	S	Il timestamp in formato compatibile con ISO-8601 ( YYYY-MM-DDTHH:MM:SS.sssZ ) in formato UTC dell'evento	30/07/2019 01:59:48.7781
azione	S	L'azione che ha attivato l'evento di controllo: Creazione conto "CRE". Conto "DIS" disabilitato Blocco dell'account "LOK". Sblocco dell'account "UOK". "USC" Accesso non riuscito 'SUC' Accesso riuscito Disconnessione utente "ULO". Modifica password utente "PWC". "TER" Chiusura della sessione a causa di eccezioni Scadenza sessione "SCAD". Le credenziali "CRD" vengono modificate 'AUT' Modifica la configurazione dell'autenticazione	SUC
attore	S	GUID dell'attore (servizio, utente, utente di sistema) che ha avviato l'operazione che ha attivato l'evento (NULL se non è possibile assegnare un determinato utente). È possibile recuperare i nomi utente correnti in base al GUID nei risultati di un'analisi exportUsers chiamata	475245454E434F000000000001000004
versione	S	La versione del software utilizzata per eseguire l'azione.	21
interfaccia	N	L'interfaccia (API, UI o URI) che attiva l'evento di controllo.	API
oggetto	N	L'oggetto di sistema che attiva l'evento di controllo.	User - 475245454E434F000000000001000004
risultato	S	L'esito positivo o negativo dell'azione. 0 indica esito positivo, 1 indica esito negativo.	0
contesto	N	Informazioni specifiche del sistema sull'evento di controllo
Contenuto dell'elemento
(nessuno)