Obtenir les événements d'audit

Récupérez les journaux d'audit de votre organisation. Les API diffèrent en fonction de l’expérience de journalisation.

Expérience des journaux unifiées

L'expérience des journaux unifiés utilise ces points de terminaison d'API et fournit deux étendues :

• Au niveau de l’organisation: /orgaudit_/
• Au niveau du locataire: /tenantaudit_/

Ces API renvoient des informations d'audit sur les services UiPath intégrés à l'infrastructure unifiée.

Point de terminaison de l’API

Pour récupérer les journaux d'audit dans l'expérience de journalisation unifiée, vous pouvez utiliser deux points de terminaison différents :

• Metadata: récupère tous les types d'événements d'audit disponibles, structurés sous la forme d'une hiérarchie de sources, de catégories et d'activités.

  Portée	Point de terminaison de l’API
  Au niveau de l'organisation	GET {accessURL}/{org-name}/orgaudit_/api/query/sources

Remplacez {accessURL} dans tous les chemins de point de terminaison par l'URL de base de votre plate-forme cloud :

Cloud Platform	URL d'accès
Test Cloud	https://cloud.uipath.com/
Test Cloud Secteur Public	https://govcloud.uipath.us/
Test Cloud dédié	https://{customURL}.dedicated.uipath.com/
Niveau du locataire	GET {accessURL}/{org-name}/{tenant-name}/tenantaudit_/api/query/sources

Remplacez {accessURL} dans tous les chemins de point de terminaison par l'URL de base de votre plate-forme cloud :

Cloud Platform	URL d'accès
Test Cloud	https://cloud.uipath.com/
Test Cloud Secteur Public	https://govcloud.uipath.us/
Test Cloud dédié	https://{customURL}.dedicated.uipath.com/

• Query Events: récupère les événements d'audit de l'étendue spécifiée, avec un filtrage avancé.

  Portée	Point de terminaison de l’API
  Au niveau de l'organisation	GET {accessURL}/{org-name}/orgaudit_/api/query/events

Remplacez {accessURL} dans tous les chemins de point de terminaison par l'URL de base de votre plate-forme cloud :

Cloud Platform	URL d'accès
Test Cloud	https://cloud.uipath.com/
Test Cloud Secteur Public	https://govcloud.uipath.us/
Test Cloud dédié	https://{customURL}.dedicated.uipath.com/
Niveau du locataire	GET``https://cloud.uipath.com/{org-name}/{tenant-name}/tenantaudit_/api/query/events

Étendues

Nécessite l’une des é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
from (facultatif)	DateTime	Début de l’intervalle de temps.
to (facultatif)	DateTime	Fin d’intervalle de temps.
source (facultatif)	Tableau [Chaîne]	Liste des sources d'événements (comme renvoyé par l'API de métadonnées ).
target (facultatif)	Tableau [Chaîne]	Liste des catégories d'événements.
type (facultatif)	Tableau [Chaîne]	Liste des types d’activités.
userIds (facultatif)	Tableau [Chaîne]	Liste des identifiants utilisateur.
searchTerm (facultatif)	Chaîne de caractères (string)	Mot-clé ou terme à rechercher.
status (facultatif)	Entier	0 = réussi 1 = échec.
maxCount (facultatif)	Entier	Nombre maximal d’enregistrements à renvoyer.

Réponses

200 OK

Renvoie un objet JSON avec :

• Liste des événements d'audit
• next lien pour la pagination affichant les événements plus récents
• previous lien pour la pagination affichant les événements plus anciens

Exemple de réponse

{
  "auditEvents": [
    {
      "id": "string",
      "createdOn": "2025-03-24T18:35:38.122Z",
      "organizationId": "string",
      "organizationName": "string",
      "tenantId": "string",
      "tenantName": "string",
      "actorId": "string",
      "actorName": "string",
      "actorEmail": "string",
      "eventType": "string",
      "eventSource": "string",
      "eventTarget": "string",
      "eventDetails": "string",
      "eventSummary": "string",
      "status": 0,
      "clientInfo": {
        "ipAddress": "string",
        "ipCountry": "string"
      }
    }
  ],
  "next": "string",
  "previous": "string"
}

Exemples de requêtes

• Au niveau de l'organisation

  curl --location 'https://cloud.uipath.com/{org-name}/orgaudit_/api/query/events?status=0&from=2024-12-24T19%3A11%3A46.403Z&to=2025-03-24T19%3A11%3A46.403Z' \
  --header 'Authorization: Bearer {token}'
  

• Niveau du locataire

  curl --location 'https://cloud.uipath.com/{org-name}/{tenant-name}/tenantaudit_/api/query/events?status=0&from=2024-12-24T19%3A11%3A46.403Z&to=2025-03-24T19%3A11%3A46.403Z' \
  --header 'Authorization: Bearer {token}'
  

Expérience des journaux classiques

Récupère les journaux d'audit d'une organisation en fonction de son nom.

Point de terminaison de l’API

GET {accessURL}/audit_/api/auditlogs/partitionGlobalId

Remplacez {accessURL} dans tous les chemins de point de terminaison par l'URL de base de votre plate-forme cloud :

Cloud Platform	URL d'accès
Test Cloud	https://cloud.uipath.com/
Test Cloud Secteur Public	https://govcloud.uipath.us/
Test Cloud dédié	https://{customURL}.dedicated.uipath.com/

Étendues

Nécessite l’une des é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 de requête	Type de données	Description
language (facultatif)	string	Spécifiez la langue d'affichage disponible, sous la forme abrégée. Par exemple, en, fr, de, ja etc.
top (facultatif)	Int32	Affichez les N premières entrées de l'audit.
skip (facultatif)	Int32	Ignore l'affichage des N premières entrées d'audit.
sortBy (facultatif)	string	Indiquez la propriété DTO utilisée pour trier les entrées d'audit. Par exemple, createdOn, category, email etc.
sortOrder (facultatif)	string	Indiquez l'ordre de tri. Par exemple, croissant (asc) ou décroissant (desc).
api-version (facultatif)	string	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://cloud.uipath.com/{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://cloud.uipath.com/{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"
        }
    ]
}