Dieses Dokument enthält Informationen über die Funktion "Audit-Protokolle anzeigen"und seine Verwendung, insbesondere über das Swagger-Tool.
Die Funktion "Audit-Protokolle anzeigen" bietet die Möglichkeit, Audit-Protokolldetails des aktuellen Benutzers abzurufen.
Um Informationen abrufen zu können, muss die API-Funktion im Benutzerkonto aktiviert sein und ein Token generiert werden.
Schritte zum Generieren eines Tokens in einem Konto, das bereits eine aktive API-Funktion hat
1. Navigieren Sie zum Abschnitt "API-Einstellungen".
2. Klicken Sie auf den Link "Hier klicken", um zum Abschnitt "Persönliche Zugangstoken".
3. Klicken Sie auf die Schaltfläche "Neues Token generieren".
4. Token-Name eingeben und Berechtigungen prüfen
5. Klicken Sie auf die Schaltfläche "Token speichern". Schaltfläche
Das generierte Token muss für die weitere Autorisierung im Swagger-Tool verwendet werden. Es ist möglich, generierte Token zu bearbeiten, zu widerrufen und zu löschen.
Wie kann ich die API für den Bereich "Audit-Protokolle anzeigen" verwenden?
Voraussetzungen
- API-Funktion ist für das Konto aktiv
- Erstellter Token
- Geprüfte Berechtigung für das generierte Token - Benutzer: Audit-Protokolle
- Inhaber-Token für die Autorisierung
Schritte zur Autorisierung eines Benutzers zur weiteren Nutzung der API für "View Audit logs" über Swagger
1. Navigieren Sie zum Abschnitt "API-Einstellungen".
2. Klicken Sie auf den Link "API-Dokumentation", um zum Abschnitt "Swagger" zu navigieren
3. Klicken Sie auf die Schaltfläche "Autorisieren".
4. Type Bearer in das geöffnete Modal ein und lassen Sie ein Leerzeichen dahinter stehen (siehe Screenshot unten)
5. Kopieren Sie das generierte Token aus dem Abschnitt "Persönliche Zugriffstoken" (API-Einstellungen >" Hier klicken"> Abschnitt "Persönliche Zugriffstoken" > Token kopieren)
6. Fügen Sie das kopierte Token in das geöffnete Modal nach Bearer
7. Klicken Sie auf die Schaltfläche "Autorisieren".
8. Klicken Sie auf die Schaltfläche "Schließen".
9. Nach erfolgreicher Autorisierung sieht die Schaltfläche wie im folgenden Screenshot aus
10. Jetzt ist der Benutzer erfolgreich autorisiert und kann die API über das Swagger-Tool nutzen!
Schritte zur Verwendung der API für "Audit-Protokolle anzeigen" über Swagger
PowerDMARC API-Dokumentation bietet API-Anweisungen für verschiedene Bereiche der Plattform.
Vorbedingungen:
- Erstellter Token
- Autorisierter Benutzer (siehe Schritte oben) auf dem Swagger
Schritte zum Start der Verwendung der API für "Audit-Protokolle anzeigen" über Swagger
1. Geben Sie "Audit-Protokolle anzeigen" in das Suchfeld ein
2. Informationen ausweiten
3. Klicken Sie auf die Schaltfläche "Try it out".
4. Ansicht Audit-Protokolle können nur nach Datum gefiltert werden (von/bis, das Datumsformat ist Jahr/Monat/Tag), außer dass die Seitenzahl und die Anzahl der Elemente pro Seite in Parametern angegeben werden können
5. Geben Sie die Anzahl der Elemente pro Seite, die Seitenzahl und die Filterung nach Datum an (siehe Screenshot unten).
6. Klicken Sie auf die Schaltfläche "Ausführen".
7. Überprüfung der Anfrage (Curl, Anfrage-URL) und der Antwortinformationen (Statuscode, Antwortkörper, Antwort-Header)
Mögliche Antwortstatuscodes:
- Der Statuscode 200 in der Antwort bedeutet, dass die Anfrage erfolgreich bearbeitet wurde und die Antwortinformationen für den Benutzer verfügbar sind.
- 401 bedeutet, dass der Benutzer nicht autorisiert ist (Token nicht bereitgestellt, oder ungültig)
- 403 bedeutet, dass ein Benutzer keine Berechtigung hat, die angeforderte Ressource abzurufen (Berechtigungen werden bei der Erstellung eines neuen Tokens nicht angegeben)
Wir hoffen, dass diese Wissenssession für Sie nützlich war. Um ein sicheres E-Mail-Erlebnis zu genießen, beginnen Sie mit der Authentifizierung Ihrer E-Mails mit DMARC noch heute!
