Audit-Protokolle werden verwendet, um Details zur Benutzeraktivität für verschiedene Dienste und Funktionen bereitzustellen. Jede in einem Protokoll aufgezeichnete Aktion enthält Metadaten, die den Aktionstyp, das Datum und die Uhrzeit, die E-Mail-ID der oder des Benutzenden, die oder der die Aktion durchgeführt hat, und weitere für den Aktionstyp relevante Attribute angeben. Die /audit/events
-Endpunkt im Audit Query Mit der API können Sie Ereignisdaten für die Aktivität Ihres Unternehmens in programmgesteuert abrufen. Platform.
Der in diesem Handbuch verwendete API-Endpunkt ist Teil der Audit Query API. Bevor Sie fortfahren, lesen Sie im Handbuch Erste Schritte die Links zu entsprechenden Dokumentationen, den Leitfaden zum Lesen der Beispiel-API-Aufrufe in diesem Dokument und wichtige Informationen zu Kopfzeilen, die für das erfolgreiche Aufrufen einer Experience Platform-API erforderlich sind.
Sie können Ereignisdaten abrufen, indem Sie eine GET-Anfrage an die /audit/events
-Endpunkt, der die Ereignisse angibt, die Sie in der Payload abrufen möchten.
API-Format
GET /audit/events
Die Audit Query API unterstützt die Verwendung von Abfrageparametern zur Seite und Filterung von Ergebnissen bei der Auflistung von Ereignissen.
Parameter | Beschreibung |
---|---|
limit |
Die maximale Anzahl von Datensätzen, die in der Antwort zurückgegeben werden. Die Standardeinstellung limit as 50. |
start |
Ein Zeiger auf das erste Element für die zurückgegebenen Suchergebnisse. Um auf die nächste Ergebnisseite zuzugreifen, sollte dieser Parameter um den durch Limit angegebenen Betrag erhöht werden. Beispiel: Um auf die nächste Ergebnisseite für eine Anfrage mit limit=50 zuzugreifen, verwenden Sie den Parameter start=50, dann start=100 für die Seite danach usw. |
queryId |
Wenn Sie eine Abfrage an den Endpunkt /audit/events senden, enthält die Antwort eine queryId -Zeichenfolgeneigenschaft. Um dieselbe Abfrage in einem separaten Aufruf durchzuführen, können Sie den ID-Wert als einen einzigen Abfrageparameter einschließen, anstatt die Suchparameter erneut manuell zu konfigurieren. |
Anfrage
curl -X POST \
https://platform.adobe.io/data/foundation/audit/events?limit=10
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'x-request-id: {TRACING_ID}' \
Antwort
Eine erfolgreiche Antwort gibt die resultierenden Datenpunkte für die in der Anfrage angegebenen Metriken und Filter zurück.
{
"_embedded": {
"customerAuditLogList": [
{
"userEmail": "{USER_ID}",
"userIpAddresses": [ ],
"eventType": "Core",
"id": "32b72208-3035-4bc6-b434-39e34401a864",
"version": "1.0",
"imsOrgId": "{ORGANIZATION_ID}",
"sandboxName": "prod",
"region": "VA7",
"requestId": "5NphpgUQdQnjTWOcS9DSMs2wD1EUMlYG",
"authId": "96715f98-d100-4575-8491-ebbcea654eb9",
"permissionResource": "Sandbox",
"permissionType": "RESET",
"assetType": "Sandbox",
"assetId": "prod",
"assetName": "prod",
"action": "Reset",
"status": "Allow",
"failureCode": "",
"timestamp": "2021-08-04T21:58:09.745+0000"
},
{
"userEmail": "{USER_ID}",
"userIpAddresses": [ ],
"eventType": "Core",
"id": "a178736a-8fa1-47da-bac5-b0d9e741e414",
"version": "1.0",
"imsOrgId": "{ORGANIZATION_ID}",
"sandboxName": "prod",
"region": "VA7",
"requestId": "7AlGIAhWvaEzYWHLzvuf26AAFAkqSyKg",
"authId": "60fc1077-4aef-4e1f-a5ff-f64183e060f4",
"permissionResource": "Sandbox",
"permissionType": "RESET",
"assetType": "Sandbox",
"assetId": "prod",
"assetName": "prod",
"action": "Reset",
"status": "Allow",
"failureCode": "",
"timestamp": "2021-08-04T21:28:00.301+0000"
},
{
"userEmail": "{USER_ID}",
"userIpAddresses": [ ],
"eventType": "Core",
"id": "ccfe8c77-9b93-481d-a561-0b2edf3b77dc",
"version": "1.0",
"imsOrgId": "{ORGANIZATION_ID}",
"sandboxName": "prod",
"region": "VA7",
"requestId": "hArqS4CAa8wfRPnKuxV4yaA82atxwzYu",
"authId": "80b7d887-9338-4cd5-9d79-2483b03f0160",
"permissionResource": "Sandbox",
"permissionType": "RESET",
"assetType": "Sandbox",
"assetId": "prod",
"assetName": "prod",
"action": "Reset",
"status": "Allow",
"failureCode": "",
"timestamp": "2021-08-04T20:58:07.750+0000"
}
]
},
"_links": {
"self": {
"href": "https://platform.adobe.io/data/foundation/audit/events?limit=10&start=0&property=type%253D%253Dcore"
},
"next": {
"href": "https://platform.adobe.io/data/foundation/audit/events?queryId=cXVlcnlJZD0xYjA4MDM4MV81ZWNkXzRjNTZfYTM2N18zYWExOWI5YzNhNTlfMTYyODExNDY5MTg1NSZ0b3RhbEVsZW1lbnRzPTI2&start=10&limit=10"
},
"page": {
"href": "https://platform.adobe.io/data/foundation/audit/events?queryId=cXVlcnlJZD0xYjA4MDM4MV81ZWNkXzRjNTZfYTM2N18zYWExOWI5YzNhNTlfMTYyODExNDY5MTg1NSZ0b3RhbEVsZW1lbnRzPTI2&limit=10{&start}",
"templated": true
}
},
"page": {
"size": 10,
"totalElements": 3,
"totalPages": 1,
"number": 1
},
"queryId": "cXVlcnlJZD0xYjA4MDM4MV81ZWNkXzRjNTZfYTM2N18zYWExOWI5YzNhNTlfMTYyODExNDY5MTg1NSZ0b3RhbEVsZW1lbnRzPTI2"
}
Eigenschaft | Beschreibung |
---|---|
customerAuditLogList |
Ein Array, dessen Objekte jedes der in der Anfrage angegebenen Ereignisse darstellen. Jedes Objekt enthält Informationen zur Filterkonfiguration und die zurückgegebenen Ereignisdaten. |
userEmail |
Die E-Mail des Benutzers, der das Ereignis ausgeführt hat. |
eventType |
Der Ereignistyp. Zu den Ereignistypen gehören Core und Enhanced . |
imsOrgId |
Die ID der Organisation, unter der das Ereignis stattfand. |
permissionResource |
Das Produkt oder die Funktion, das bzw. die die Berechtigung erteilt hat, führt die Aktion aus. Eine Ressource kann eine der folgenden sein:
|
permissionType |
Der Berechtigungstyp, der mit der Aktion verbunden ist. |
assetType |
Der Typ der Platform-Ressource, für die die Aktion ausgeführt wurde. |
assetId |
Eine eindeutige Kennung für die Platform-Ressource, für die die Aktion ausgeführt wurde. |
assetName |
Der Name der Platform-Ressource, für die die Aktion ausgeführt wurde. |
action |
Die Art der Aktion, die für das Ereignis aufgezeichnet wurde. Eine Aktion kann eine der folgenden sein:
|
status |
Der Status der Aktion. Ein Status kann einer der folgenden sein: Allow Deny Failure Success |