Obtenir les journaux d’audit

Point de terminaison de l'API pour la récupération des journaux d'audit d'une organisation par nom d'organisation dans Automation Suite.

Obtient les journaux d'audit d'une organisation, en fonction du nom de l'organisation.

Point de terminaison de l’API

GET https://{yourDomain}/audit_/api/auditlogs

Étendues

Nécessite les étendues suivantes :

• PM.Audit
• PM.Audit.Read

En-têtes de requête.

--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'

Paramètres de requête

Paramètre	Type de données	Description
language	string	Facultatif. Spécifiez la langue d'affichage disponible, sous la forme abrégée. Par exemple, en, fr, de, ja etc.
top	Int32	Facultatif. Affichez les N premières entrées de l'audit.
skip	Int32	Facultatif. Ignore l'affichage des N premières entrées d'audit.
sortBy	string	Facultatif. Indiquez la propriété DTO utilisée pour trier les entrées d'audit. Par exemple, createdOn, category, email etc.
sortOrder	string	Facultatif. Indiquez l'ordre de tri. Par exemple, croissant (asc) ou décroissant (desc).
api-version	string	Facultatif. Indiquez la version de l'API que vous utilisez.

Réponses

200 OK

Renvoie les événements d'audit demandés.

Exemple de requête

Supposons que vous ayez rassemblé toutes les informations nécessaires pour créer l'appel d'API.

• Votre {baseURL} est : https://{yourDomain}/{organizationName}
• Votre {access_token} est : 1234 (pour des considérations de longueur).
• Vous définissez les paramètres de requête suivants:
  • language = en
  • top = 2, pour afficher les deux premières entrées
  • skip = 2, pour ignorer les deux premières entrées
  • sortBy = createdOn pour trier les entrées en fonction de leur heure de création
  • sortOrder = asc pour trier les entrées de la plus ancienne à la plus récente

L’appel doit ressembler à l’exemple suivant (cURL) :

curl --location --request GET ' https://{yourDomain}/{organizationName}/audit_/api/auditlogs/?language=en&top=2&skip=2&sortBy=createdOn&sortOrder=asc' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'

Voici le corps de la réponse pour une récupération réussie des entrées d’audit :

{
    "totalCount": 29,
    "results": [
        {
            "createdOn": "2021-10-14T13:10:15.1964174+00:00",
            "category": "User",
            "action": "Login",
            "auditLogDetails": "{\r\n \"userName\": \"System Administrator admin\",\r\n \"email\": \"\"\r\n}", 
            "userName": "System Administrator",
            "email": "",
            "message": "User 'System Administrator admin' logged in",
            "detailsVersion": "1.0",
            "source": "Cis"
        },
....
        {
            "createdOn": "2021-10-14T12:41:00.3268964+00:00",
            "category": "User",
            "action": "Login",
            "auditLogDetails": "{\r\n \"userName\": \"System Administrator admin\",\r\n \"email\": \"\"\r\n}", 
            "userName": "System Administrator",
            "email": "",
            "message": "User 'System Administrator admin' logged in",
            "detailsVersion": "1.0",
            "source": "Cis"
        }
    ]
}