Audit-API

Verwenden Sie die Audit-API, um Audit-Daten für eine bestimmte Eingabekombination von Datumsfilter, Sortiermechanismus und Paginierung anzufordern.

1. Alle API-Aufrufe müssen ein Authentifizierungs-Token in der Kopfzeile der Anfrage enthalten. Verwenden Sie die Authentifizierung API, um ein JSON-Web-Token zu erzeugen. Einzelheiten finden Sie unter Authentifizierungs-API.
2. Anwendung von Filtern zur Durchführung grundlegender bedingter Abfragen und zur Steuerung der Paginierung bei der Bearbeitung von Webseiten.
   Es gibt drei grundlegende Funktionen im Zusammenhang mit der Filterung: Filterbedingungen, Sortierspalten und Paginierungsparameter.

   Filtern, Paginieren und Sortieren

3. Verwenden Sie die POST-Methode und die Endpunkt-URL:<Ihr_Kontrollraum_url>/v1/audit/messages/list.
   Das folgende Beispiel fragt erfolglose Anmeldeversuche für den Monat Dezember 2019 ab.

   Anforderungstext:

   {
     "sort": [
       {
         "field": "createdOn",
         "direction": "desc"
       }
     ],
     "filter": {
       "operator": "and",
       "operands": [
         {
           "operator": "gt",
           "field": "createdOn",
           "value": "2019-12-01T00:00:00.001Z"
         },
         {
           "operator": "lt",
           "field": "createdOn",
           "value": "2019-12-31T23:59:59.999Z"
         },
         {
           "operator": "eq",
           "field": "status",
           "value": "Unsuccessful"
         },
         {
           "operator": "substring",
           "field": "activityType",
           "value": "LOGIN"
         },
         {
           "operator": "substring",
           "field": "userName",
           "value": "joe.typical@myemiil.com"
         }
       ]
     },
     "fields": [],
     "page": {
       "length": "1000",
       "offset": "0"
     }
   }

4. Senden Sie die Anfrage.
   Die Antwort für dieses Beispiel liefert Daten für den Datumsfilter, die Sortierung und die Paginierung. Wenn in der Anfrage keine Filterung verwendet wird, gibt eine erfolgreiche Antwort alle Seiten für die angegebene Control Room.

   Antworttext:

   {
     "page": {
       "offset": 0,
       "total": 731064850,
       "totalFilter": 9
     },
     "list": [
       {
         "id": "XlHj6G4BFXSpOOji5B7S",
         "eventDescription": "User does not exist in Control Room.",
         "activityType": "LOGIN",
         "environmentName": "",
         "hostName": "12.xxx.xx.x",
         "userName": "joe.typical@myemiil.com",
         "status": "Unsuccessful",
         "source": "Control Room",
         "objectName": "N/A",
         "detail": "",
         "createdOn": "2019-12-09T04:21:19Z",
         "requestId": "04965c2e-82e0-4ce4-a88d-bebe1dc3a2a8",
         "createdBy": "0"
       },
       {
         "id": "g1Hj6G4BFXSpOOji2Rwx",
         "eventDescription": "User does not exist in Control Room.",
         "activityType": "LOGIN",
         "environmentName": "",
         "hostName": "12.xxx.xx.x",
         "userName": "joe.typical@myemiil.com",
         "status": "Unsuccessful",
         "source": "Control Room",
         "objectName": "N/A",
         "detail": "",
         "createdOn": "2019-12-09T04:21:16Z",
         "requestId": "61672553-477d-4012-ab47-2a27f6553c4e",
         "createdBy": "0"
       },
       ..............................
       {
         "id": "ETyk6G4BFXSpOOjiaJjt",
         "eventDescription": "User does not exist in Control Room.",
         "activityType": "LOGIN",
         "environmentName": "",
         "hostName": "12.xxx.xx.x",
         "userName": "joe.typical@myemiil.com",
         "status": "Unsuccessful",
         "source": "Control Room",
         "objectName": "N/A",
         "detail": "",
         "createdOn": "2019-12-09T03:11:58Z",
         "requestId": "ebeb01de-1f81-4a7c-8978-405806e146bd",
         "createdBy": "0"
       }
     ]
   }