Ce document fournit des informations sur la fonction "Afficher les journaux d'audit"et son utilisation, notamment via l'outil Swagger.
L'option "View Audit logs" permet d'obtenir les détails du journal d'audit de l'utilisateur actuel.
Pour commencer à obtenir des informations, la fonction API doit être active sur le compte de l'utilisateur et un jeton doit être généré.
Étapes à suivre pour générer un jeton dans un compte qui possède déjà une fonctionnalité API active
1. Accédez à la section "Paramètres de l'API".
2. Cliquez sur le lien " cliquez ici " pour accéder à la section "Tokens d'accès personnels".
3. Cliquez sur le bouton "Générer un nouveau jeton".
4. Entrez le nom du jeton et vérifiez les permissions
5. Cliquez sur le bouton "Enregistrer le jeton". bouton
Le jeton généré doit être utilisé pour une autorisation ultérieure dans l'outil Swagger. Il est possible de modifier, révoquer et supprimer les jetons générés.
Comment utiliser l'API pour la section "Afficher les journaux d'audit" ?
Conditions préalables
- La fonction API est active pour le compte
- Jeton généré
- Vérification de la permission pour le jeton généré - utilisateur : journaux d'audit
- Jeton porteur pour l'autorisation
Étapes à suivre pour autoriser un utilisateur à utiliser l'API pour "View Audit logs" via Swagger.
1. Accédez à la section "Paramètres de l'API".
2. Cliquez sur le lien "API Documentation" pour accéder à la section Swagger.
3. Cliquez sur le bouton "Autoriser".
4. TTapez Bearer dans la modale ouverte et laissez un espace après (voir la capture d'écran ci-dessous).
5. Copiez le jeton généré à partir de la section "Jetons d'accès personnels" (paramètres de l'API > lien "cliquez ici" > section Jetons d'accès personnels>Copier le jeton)
6. Collez le jeton copié dans la modale ouverte après Bearer
7. Cliquez sur le bouton "Autoriser".
8. Cliquez sur le bouton "Fermer
9. Après une autorisation réussie, le bouton ressemblera à la capture d'écran ci-dessous
10. L'utilisateur est maintenant autorisé avec succès et peut commencer à utiliser l'API via l'outil Swagger !
Étapes de l'utilisation de l'API pour "Afficher les journaux d'audit" via Swagger
PowerDMARC Documentation API fournit des instructions API pour différentes sections de la plateforme.
Conditions préalables :
- Jeton généré
- Utilisateur autorisé (voir les étapes ci-dessus) sur le Swagger
Étapes pour commencer à utiliser l'API pour "View Audit logs" via Swagger
1. Entrez "View audit logs" dans le champ de recherche.
2. Développer l'information
3. Cliquez sur le bouton "Essai".
4. View Les journaux d'audit ne peuvent être filtrés que par date (de/à, le format de la date est année/mois/jour), sauf que le numéro de page et le nombre d'éléments par page peuvent être spécifiés dans les paramètres.
5. Spécifiez le nombre d'éléments par page, le numéro de page et le filtre par date (voir la capture d'écran ci-dessous).
6. Cliquez sur le bouton "Exécuter".
7. Vérifier les informations de la demande (Curl, URL de la demande) et de la réponse (code d'état, corps de la réponse, en-têtes de la réponse).
Codes d'état de réponse possibles :
- Le code d'état 200 en réponse signifie que la demande a été traitée avec succès et que les informations de réponse sont disponibles pour l'utilisateur.
- 401 signifie que l'utilisateur n'est pas autorisé (le jeton n'a pas été fourni ou il n'est pas valide).
- 403 signifie qu'un utilisateur n'a pas la permission d'obtenir la ressource demandée (les permissions ne sont pas spécifiées lors de la génération d'un nouveau jeton).
Nous espérons que cette session de connaissances vous a été utile. Pour profiter d'une expérience de courrier électronique plus sûre, commencez à authentifier vos courriels avec le protocole DMARC dès aujourd'hui !
