Dit document geeft informatie over de "Bekijk audit logs" en het gebruik ervan, met name via het Swagger gereedschap.
"Bekijk Audit logs" geeft de mogelijkheid om audit log details van de huidige gebruiker op te vragen.
Om informatie te krijgen moet de API-functie actief zijn op de gebruikersaccount en moet een token worden gegenereerd.
Stappen om een token te genereren in een account die al een actieve API-functie heeft
1. Navigeer naar de "API instellingen" sectie
2. Klik op de "klik hier" link om naar de "Persoonlijke toegangsmunten" sectie
3. Klik op de knop "Nieuw token genereren".
4. Voer de naam van het token in en controleer de machtigingen
5. Klik op de knop "Token opslaan knop
Het gegenereerde token moet worden gebruikt voor verdere autorisatie in de Swagger-tool. Het is mogelijk om gegenereerde tokens te bewerken, in te trekken en te verwijderen.
Hoe gebruik ik de API voor het onderdeel "Auditlogs bekijken"?
Randvoorwaarden
- API-functie is actief voor de rekening
- Gegenereerd token
- Toestemming gecontroleerd voor het gegenereerde token - gebruiker: audit logs
- Draaginsigne voor autorisatie
Stappen om een gebruiker te autoriseren voor verder gebruik van de API voor "View Audit logs" via Swagger
1. Navigeer naar de "API instellingen" sectie
2. Klik op de link "API-documentatie" om naar de Swagger-sectie te gaan.
3. Klik op de knop "Autoriseren
4. Type Bearer op het geopende modal en laat er een spatie achter (zie screenshot hieronder)
5. Kopieer het gegenereerde token uit de sectie "Persoonlijke toegangstokens" (API-instellingen >" klik hier link"> Persoonlijke toegangstokens sectie>Kopieer token)
6. Plak het gekopieerde token in het geopende modal na Bearer
7. Klik op de knop "Autoriseren
8. Klik op de knop "Sluiten".
9. Na succesvolle autorisatie ziet de knop eruit zoals in de onderstaande schermafbeelding
10. Nu is de gebruiker succesvol geautoriseerd en kan hij de API gaan gebruiken via de Swagger-tool!
Stappen voor het gebruik van API voor "Auditlogs bekijken" via Swagger
PowerDMARC API documentatie biedt API-instructies voor verschillende onderdelen van het platform.
Voorwaarden:
- Gegenereerd token
- Geautoriseerde gebruiker (zie bovenstaande stappen) op de Swagger
Stappen om API te gebruiken voor "Auditlogs bekijken" via Swagger
1. Voer in het zoekveld "Auditlogs bekijken" in
2. Informatie uitbreiden
3. Klik op de knop "Uitproberen
4. Bekijk Auditlogs kunnen alleen worden gefilterd op datum (van/tot, het datumformaat is jaar/maand/dag), behalve dat het paginanummer en het aantal items per pagina kunnen worden opgegeven in parameters
5. Specificeer het aantal items per pagina, het paginanummer en filter op datum (zie onderstaande schermafbeelding).
6. Klik op de knop "Uitvoeren
7. Verzoek (Curl, Request URL) en antwoordinformatie (Statuscode, Response body, Response headers) verifiëren.
Mogelijke antwoordstatuscodes:
- Statuscode 200 in het antwoord betekent dat het verzoek met succes is behandeld en dat er antwoordinformatie beschikbaar is voor de gebruiker.
- 401 betekent dat de gebruiker niet geautoriseerd is (token niet verstrekt, of het is ongeldig)
- 403 betekent dat een gebruiker geen rechten heeft om de gevraagde bron te verkrijgen (rechten worden niet gespecificeerd tijdens het genereren van een nieuw token)
Hopelijk was deze kennissessie nuttig voor u. Voor een veiligere e-mailervaring begint u met het verifiëren van uw e-mails met DMARC vandaag nog!
