exportSecurityAudit
Wird unterstützt in API v20 +
Kategorie
| Datenabruf |
Beschreibung
| Gibt einen Bericht aller Sicherheitsereignisse in einem angegebenen Zeitbereich zurück, filterbar nach Ereignisart. Zu den Sicherheitsereignissen gehören erfolglose Anmeldeversuche, Kennwortänderungen, Kontosperrung, Kontoerstellung und andere sicherheitsrelevante Informationen. Wenn kein Zeitbereich angefordert wird, werden alle Ereignisse der letzten 24 Stunden zurückgegeben. Vom Auditprotokoll erfasste Sicherheitsereignisse basieren auf NIST 800-53. Adaptive Planning speichert nur 30 Tage Sicherheitsauditdaten. |
Zum Aufrufen sind Berechtigungen erforderlich
| Administrator |
Auf Anforderung erforderliche Parameter
| Zugangsdaten |
Die Anforderung dieser Methode enthält ein Credentials-Tag zur Identifizierung und Autorisierung des aufrufenden Benutzers sowie ein include-Tag, das den Akteur und den Zeitbereich angibt, für den Sicherheitsereignisse abgerufen werden sollen. Nach der Verifizierung gibt die Methode ein XML-Dokument zurück, das alle Sicherheitsereignisse im angegebenen Zeitbereich beschreibt und nach Ereignisart filterbar ist.
Anforderungsformat
<?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>
Element „Zugangsdaten“.
| |||
Tag-Name
| -Zugangsdaten | ||
Beschreibung
| Alle API-Aufrufe müssen ein einzelnes Element mit den Zugangsdaten enthalten, um den Benutzer zu identifizieren, der die API aufruft. Der API-Aufruf wird dann als dieser Benutzer ausgeführt (jeder Audit-Trail oder jede Aktionshistorie im System zeigt, dass dieser Benutzer die Aktion ausgeführt hat). Daher muss der Benutzer über die erforderlichen Berechtigungen zum Ausführen der Aktion verfügen, damit der API-Aufruf ausgeführt werden kann erfolgreich ist. | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
anmelden | J | Der Anmeldename des Benutzers, der die API-Methode aufruft. Dieser Benutzer muss über die erforderlichen Berechtigungen zum Aufrufen der Methode verfügen. | sampleuser@company.com |
Kennwort | J | Das Kennwort des Benutzers, der die API-Methode aufruft. | my_password |
Inhalt des Elements
| |||
Keine | |||
Element einschließen
| |||
Tag-Name
| einschließen | ||
Beschreibung
| |||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
Akteur | N | Der Benutzername, dessen Sicherheitsereignisse Sie abrufen möchten. Gibt Ereignisse für alle Benutzer zurück, wenn kein Akteur eingeschlossen ist. | stevec@greenco.com |
dateTimeFrom | N | Der Beginn des Zeitbereichs im ISO-8601-kompatiblen Format ( JJJJ-MM-TTTHH:MM:SS ) in UTC für die Sicherheitsereignisse, die Sie abrufen möchten. | 2019-07-30 00:00:00 |
dateTimeTo | N | Das Ende des Zeitbereichs im ISO-8601-kompatiblen Format ( JJJJ-MM-TTTHH:MM:SS ) in UTC für die Sicherheitsereignisse, die Sie abrufen möchten. | 30.07.2019, 11:59:59 |
Inhalt des Elements
| |||
Keine | |||
Antwortformat
<?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>
Antwortelement
| |||
Tag-Name
| -Antwort | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
Erfolg haben | J | Entweder wahr oder falsch, was angibt, ob der API-Aufruf erfolgreich war oder nicht. Selbst erfolgreiche Aufrufe können in ihrer Antwort Warnmeldungen enthalten. | wahr |
veraltet | N | Wenn dieses Attribut im Antwort-Tag vorhanden und auf „true“ gesetzt ist, zeigt es an, dass die Version der Methode oder API, die aufgerufen wird, veraltet ist und von offiziell als veraltet markiert wird Adaptive Planning . Auch wenn es zu diesem Zeitpunkt noch funktioniert, kann es sein, dass Sie in Kürze nicht mehr funktionieren. In der Regel ist dieses Attribut nicht vorhanden. | false |
Inhalt des Elements
| |||
Ein einzelnes optionales Nachrichtenelement und genau ein erforderliches Ausgabeelement. | |||
Ausgabeelement
| |
Tag-Name
| Ausgabe |
Attribute des Elements
| |
(Keine) | |
Inhalt des Elements
| |
Einzelnes Auditelement Dieser Ausgabe-Wraper ist ein Standard für alle API-Antworten und schließt die gültige Ausgabe jedes erfolgreichen API-Aufrufs ein. | |
Audit-Element
| |||
Tag-Name
| Audit | ||
Beschreibung
| Eine Sammlung von Sicherheitsereignissen. | ||
Attribute des Elements
| |||
(Keine) | |||
Inhalt des Elements
| |||
Ein oder mehrere Ereigniselemente. | |||
Ereigniselement
| |||
Tag-Name
| -Ereignis | ||
Beschreibung
| Ein Sicherheitsereignis. | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
timestamp | J | Der Zeitstempel im ISO-8601-kompatiblen Format ( YYYY-MM-TTTHH:MM:SS.sssZ ) in UTC des Ereignisses | 30.07.2019, 01:59:48.7781 |
Aktion | J | Die Aktion, die das Auditereignis getriggert hat:
| SUC |
Akteur | J | GUID des Akteurs (Service, Benutzer, Systembenutzer), der den Vorgang initiiert hat, der das Ereignis auslöst (NULL, wenn kein bestimmter Benutzer zugewiesen werden kann).
Sie können aktuelle Benutzernamen nach GUID in den Ergebnissen einer abrufen exportUsers anzurufen. | 475245454E434F000000000001000004
|
Version | J | Die Version der zum Ausführen der Aktion verwendeten Software. | 21 |
-Schnittstelle | N | Die Schnittstelle (API, UI oder URI), die das Auditereignis auslöst. | API (Application Programming Interface) |
-Objekt | N | Das Systemobjekt, das das Auditereignis triggert. | User - 475245454E434F000000000001000004
|
Ergebnis | J | Erfolgreich oder fehlgeschlagen die Aktion. 0 steht für Erfolg, 1 für Fehler. | 0 |
context | N | Systemspezifische Informationen zum Auditereignis. | |
Inhalt des Elements
| |||
(Keine) | |||