Messages d'audit de ThingWorx
Cette rubrique fournit des informations concernant le contenu des messages d'audit ThingWorx dans les sections suivantes :
Types de messages d'audit
Le sous-système d'audit génère des messages pour diverses activités de ThingWorx Platform. Les principaux types de messages sont les suivants :
Modifications apportées à un objet : audit des modifications, telles que la création, la suppression ou la modification d'une entité. Il peut s'agir d'un objet ou d'un autre type de données comme un sous-système ou une organisation.
Modifications apportées à des utilisateurs : audit des modifications, telles que la création ou la modification d'un utilisateur ou d'une clé d'application.
Opérations sur un objet : audit des opérations sur une entité. Il peut s'agir d'activités de session à distance (tunnellisation) sur un objet.
Opérations sur le système : audits pour lesquels aucun objet cible n'existe pour le message (connexion utilisateur et opérations d'importation/exportation).
Les messages d'audit contiennent des entrées d'audit, qui fournissent les informations concernant l'activité.
* 
Pour plus d'informations sur l'audit d'un commutateur dans un contexte de sécurité, consultez la section Audit du changement de contexte de sécurité .
Entrées d'audit
Chaque entrée d'audit est constituée de deux composants : une clé de catégorie d'audit et une clé de message d'audit.
La clé de catégorie d'audit est un jeton de localisation qui spécifie la zone fonctionnelle, ou la catégorie, à laquelle le message d'audit est associé. Cette clé est de type STRING. Pour obtenir une liste des catégories, consultez la section Catégories d'audit.
La clé de message d'audit est un jeton de localisation qui pointe vers le texte du message d'audit. Cette clé est de type STRING.
La valeur de chaque composant est extraite de l'instance ou de la définition d'événement intégrée correspondante. Notez que l'audit des événements définis par l'utilisateur n'est pas pris en charge.
Arguments de message d'audit
Le message d'audit fournit des arguments qui sont utilisés pour générer un message localisé et le nom de l'entité qui a effectué l'opération. Il s'agit d'un élément ValueCollection de paires nom/valeur de remplacement utilisées pour générer le message localisé. Ces informations sont récupérées dans les champs eventData de l'instance d'événement. Une entité ThingWorx (par exemple, un objet ou un utilisateur) est associée à un message d'audit, qui indique l'utilisateur ou l'élément qui a réalisé l'opération concernée par le message d'audit.
Catégories d'audit
Toutes les entrées d'audit sont associées à une catégorie d'audit. Ces catégories facilitent le filtrage des données d'audit et l'identification d'une tendance concernant les activités d'une catégorie précise d'opérations. En outre, les catégories d'audit peuvent vous aider à détecter les tentatives d'accès non autorisé ou des problèmes de connexion à votre ThingWorx Platform d'un périphérique Edge.
Chaque entrée d'audit possède une catégorie unique, qui est stockée sous la forme d'une chaîne avec l'entrée d'audit. La chaîne de catégorie d'audit affichée est localisée. La catégorie d'audit s'affiche dans la langue appropriée selon les paramètres régionaux préférés de l'utilisateur.
La table ci-après répertorie et décrit brièvement les catégories disponibles dans le sous-système d'audit.
Catégorie
Description
Exemples
Jeton de localisation
ANALYTICS
Actions relatives aux entités Analytique. Opérations effectuées par ThingWorx Analytics
Opérations de création, de modification et de suppression appliquées aux définitions d'analyses de données
Autres actions effectuées dans ThingWorx Analytics
audit.AuditCategory.Analytics
AUTHENTICATION
Actions relatives à l'authentification
Connexion de l'utilisateur (succès ou échec), verrouillage de l'utilisateur et erreurs liées à l'utilisation des clés d'application. Par exemple : Login successful for user: Administrator.
audit.AuditCategory.Authentication
COLLABORATION
Actions relatives aux entités collaboration
Opérations de création, de modification et de suppression appliquées aux blogs et wikis
audit.AuditCategory.Collaboration
DATA_MANAGEMENT
Actions relatives à la gestion ou à l'utilisation des données
Opérations de suppression appliquées aux données
audit.AuditCategory.DataManagement
DATA_STORAGE
Actions relatives aux entités stockage de données et aux sous-systèmes associés
Opérations de création, de modification et de suppression appliquées aux tables de données, aux flux et à d'autres entités stockage de données
audit.AuditCategory.DataStorage
DEVICE_COMMUNICATION
Actions et événements relatifs à la communication avec les périphériques Edge
Services importants appelés sur les objets distants (RestartThing, EnableThing, DisableThing)
Le service CloseWebSocketSessions de WSCommunicationSubsystem est audité. Pour plus d'informations sur le service, consultez la rubrique Sous-système de gestion des communications WebSocket.
audit.AuditCategory.DeviceCommunication
FILE_TRANSFER
Actions et événements relatifs aux chargements et téléchargements de fichiers
Pour les transferts de fichiers : réussite d'un transfert, annulation d'un transfert et génération d'erreurs lors d'un transfert
audit.AuditCategory.FileTransfer
IMPORT_EXPORT
Actions relatives à l'importation et l'exportation de données vers et depuis ThingWorx
Opérations d'importation/exportation de modèles et de données
Importation d'une extension
audit.AuditCategory.ImportExport
LIFECYCLE
Actions relatives à un événement spécifique un objet, tel que ThingStart
Evénement ThingStart
audit.AuditCategory.Lifecycle
MODELING
Actions relatives aux entités Modélisation Lorsqu'une entité est créée, le système génère un message d'audit qui inclut le propriétaire affecté à la nouvelle entité. Notez que le propriétaire d'une entité est défini automatiquement sur le nom d'utilisateur qui a créé l'entité.
Le système génère un message d'audit lorsque l'une des méthodes suivantes de création d'entité est utilisée :
Via l'appel de PUT dans Composer
Via un appel d'une API Create, d'une API Clone ou de l'API SetOwner
Tout utilisateur autorisé à consulter le sous-système d'audit peut afficher des rapports concernant les modifications de propriété.
Opérations de création, de modification et de suppression appliquées aux objets, modèles d'objet, formes d'objet, formes de données, réseaux, projets, modèles et tags
Le format du message d'audit est le suivant :
"Created <Source Type> <Source> with owner <username of owner>."
Où :
Source Type correspond au type d'entité créé. Par exemple, un objet.
Source correspond au nom de la nouvelle entité.
owner affiche le username (nom d'utilisateur) de l'utilisateur qui exécute l'action de création.
Clé de catégorie : audit.AuditCategory.Modeling
Clé de message : audit.EntityLifecycle.Create
REMOTE_ACCESS
Actions relatives à l'accès à distance (tunnellisation)
Début/fin de session (événement TunnelSession), annulation de session
audit.AuditCategory.RemoteAccess
SCM (Software Content Management)
Actions relatives aux packages, déploiements et modifications de configuration
Création, modification, publication et suppression de packages. Création, lancement, transition et suppression de déploiements. Inclut les déploiements test et effectifs, les actifs spécifiés pour un déploiement test, et la réussite ou l'échec de l'installation de packages. Modifications de configuration pour la purge automatique et pour les déploiements simultanés
audit.AuditCategory.SoftwareManagement
SECURITY_CONFIGURATION
Actions associées aux entités et autorisations de sécurité, y compris les utilisateurs, les groupes d'utilisateurs, les groupes d'objets, les organisations, les clés d'application, les services d'annuaire et les authentificateurs
Un message d'audit est généré chaque fois que le propriétaire d'une entité est modifié. Un propriétaire peut être modifié via Composer, via un appel d'API ou via l'importation d'un fichier XML d'entités.
Un message d'audit de propriété n'est pas généré dans les cas suivants :
Le sous-système d'audit est désactivé.
L'entité a été mise à jour sans modification de propriété.
L'appel de l'API SetOwner a défini le même propriétaire qui était déjà celui de l'entité.
Opérations de création, de modification et de suppression appliquées aux utilisateurs, groupes d'utilisateurs, groupes d'objets, organisations, clés d'application, services d'annuaire et authentificateurs
Active le suivi des modifications associées aux groupes d'utilisateurs. L'entrée audit.Groups.Added est générée chaque fois qu'un utilisateur ou un groupe d'utilisateurs est ajouté en tant que membre d'un autre groupe d'utilisateurs. L'entité audit.Groups.Removed est générée chaque fois qu'un utilisateur ou un groupe d'utilisateurs est supprimé d'un groupe d'utilisateurs.
Modifications des autorisations des entités (tous les types d'entités) Reportez-vous à la section ci-dessus Audit du changement de contexte de sécurité.
Le format général du message d'audit de modification de propriété est le suivant :
"Owner for <Source Type> <Source> changed from <original owner username> to <new owner username>."
Où :
Source Type correspond au type d'entité dont le propriétaire a été modifié. Par exemple, un objet.
Source correspond au nom de l'entité dont le propriétaire a été modifié.
original owner username affiche le username (nom d'utilisateur) de l'utilisateur qui exécute l'action de modification.
new owner username est le username (nom d'utilisateur) du nouveau propriétaire.
Clé de catégorie : audit.AuditCategory.SecurityConfiguration
Clés de message :
audit.Groups.Added
audit.Groups.Removed
audit.entity.ownership.change
Administrateur activant et désactivant la délégation des autorisations de visibilité sur les groupes d'utilisateurs dans le sous-système de gestion des utilisateurs
Les opérations et les messages d'audit suivants sont audités :
L'administrateur a activé la délégation des autorisations de visibilité sur les groupes d'objets dans le sous-système de gestion des utilisateurs : le message d'audit est "Délégation de permission de visibilité du groupe d'objets activée".
L'administrateur a désactivé la délégation des autorisations de visibilité sur les groupes d'objets dans le sous-système de gestion des utilisateurs : le message d'audit est "Délégation de permission de visibilité du groupe d'objets désactivée".
Clé de catégorie : audit.AuditCategory.SecurityConfiguration
Clés de message :
com.thingworx.thinggroups.ThingGroup.VisibilityPermissionDelegationEnabled
com.thingworx.thinggroups.ThingGroup.VisibilityPermissionDelegationDisabled
SYSTEM
Actions relatives aux entités système
Opérations de création, de modification et de suppression appliquées aux tables de localisation, ressources, sous-systèmes et journaux
Actions et modifications de configuration des sous-systèmes, y compris le démarrage, l'arrêt et le redémarrage. Toutes les entrées associées aux sous-systèmes apparaissent dans cette catégorie et n'appartiendront à aucune autre catégorie.
* 
L'opération de redémarrage génère deux ou trois messages d'audit, en fonction du statut du sous-système lors de l'appel du redémarrage. Si le statut du sous-système est RUNNING, trois messages sont écrits, un message par opération (redémarrage, arrêt et démarrage). Si le statut du sous-système n'est pas RUNNING, deux messages sont écrits, un message par opération (redémarrage et démarrage). L'action d'arrêt n'est pas exécutée dans ce cas.
audit.AuditCategory.System
VISUALIZATION
Actions relatives aux entités Visualisation
Opérations de création, de modification et de suppression appliquées aux applications composites, modèles de base, gadgets, tableaux de bord, menus, entités de média, définitions de style et définitions d'état
audit.AuditCategory.Visualization