exportSecurityAudit
Prise en charge dans API v20 et supérieure
Catégorie | Récupération des données |
Description | Renvoie un rapport de tous les événements de sécurité dans une plage de temps spécifique, pouvant être filtré par type d'événement. Les événements de sécurité incluent les tentatives de connexion infructueuses, les modifications de mot de passe, le verrouillage de compte, la création de compte et d'autres informations relatives à la sécurité. Si aucune plage de temps n'est demandée, tous les événements des 24 dernières heures sont renvoyés. Les événements de sécurité enregistrés par le journal d'audit sont basés sur la norme NIST 800-53. Adaptive Planning ne conserve que 30 jours de données d'audit de sécurité. |
Autorisations requises pour appeler | Administrateur |
Paramètres obligatoires à la demande | Identifiants |
La demande de cette méthode contient un marqueur d'identifiant pour identifier et autoriser l'utilisateur appelant, ainsi qu'un marqueur d'inclusion identifiant l'auteur et la plage de temps pour laquelle récupérer les événements de sécurité. Une fois vérifiée, la méthode renvoie un document XML décrivant tous les événements de sécurité dans la plage de temps spécifiée, pouvant être filtrée par type d'événement.
Format de demande
<?xml version='1.0' encoding='UTF-8'?> <call method="exportSecurityAudit" callerName="a string that identifies your client application"> <credentials login="sampleuser@company.com" password="my_pwd"/> <include actor="stevec@greenco.com" dateTimeFrom="2019-07-30 00:00:00" dateTimeTo="2019-07-30 11:59:59"/> </call>
élément identifiants | |||
Nom du marqueur | identifiants | ||
Description | Tous les appels d'API doivent contenir un seul élément identifiants pour identifier l'utilisateur qui a appelé l'API. L'appel d'API est ensuite effectué en tant qu'utilisateur ( n'importe quelle piste d'audit ou historique d'actions dans le système indique que cet utilisateur a effectué l'action) et, par conséquent, l'utilisateur doit avoir les autorisations requises pour effectuer l'action afin que l'appel d'API s'appelle réussir. | ||
Attributs de l'élément | |||
Nom de l'attribut | Obligatoire ? | Valeur | Exemple |
se connecter | O | Le nom de connexion de l'utilisateur appelant la méthode API. Cet utilisateur doit avoir les autorisations requises pour appeler la méthode. | sampleuser@company.com |
mot de passe | O | Mot de passe de l'utilisateur appelant la méthode API. | my_password |
Contenu de l'élément | |||
aucun(e) | |||
inclure l'élément | |||
Nom du marqueur | inclure | ||
Description | |||
Attributs de l'élément | |||
Nom de l'attribut | Obligatoire ? | Valeur | Exemple |
acteur | N | Le nom d'utilisateur dont vous souhaitez extraire les événements de sécurité. Renvoie les événements pour tous les utilisateurs lorsque l'auteur n'est pas inclus. | stevec@greenco.com |
dateTimeFrom | N | Début de la plage de temps au format compatible ISO-8601 ( YYYY-MM-JJTHH:MM:SS ) en UTC pour les événements de sécurité que vous souhaitez récupérer. | 2019-07-30 00:00:00 |
dateTimeTo | N | La fin de la plage de temps au format compatible ISO-8601 ( YYYY-MM-JJTHH:MM:SS ) en UTC pour les événements de sécurité que vous souhaitez récupérer. | 2019-07-30 11:59:59 |
Contenu de l'élément | |||
aucun(e) | |||
Format de la réponse
<?xml version='1.0' encoding='UTF-8'?> <response success="true"> <output> <audit> <event timestamp="2019-07-30 01:59:48.7781" action="SUC" actor="475245454E434F000000000001000004" version="20" interface="" object="User - 475245454E434F000000000001000004" outcome="0" context="" /> <event timestamp="2019-07-30 01:59:48.9822" action="SUC" actor="475245454E434F000000000001000004" version="20" interface="" object="User - 475245454E434F000000000001000004" outcome="0" context="" /> <event timestamp="2019-07-30 02:01:29.115" action="SUC" actor="475245454E434F000000000001000004" version="20" interface="" object="User - 475245454E434F000000000001000004" outcome="0" context="" /> <event timestamp="2019-07-30 02:02:03.0594" action="SUC" actor="475245454E434F000000000001000004" version="20" interface="" object="User - 475245454E434F000000000001000004" outcome="0" context="" /> <event timestamp="2019-07-30 02:06:35.8937" action="SUC" actor="475245454E434F000000000001000004" version="20" interface="" object="User - 475245454E434F000000000001000004" outcome="0" context="" /> <event timestamp="2019-07-30 02:06:36.0589" action="SUC" actor="475245454E434F000000000001000004" version="20" interface="" object="User - 475245454E434F000000000001000004" outcome="0" context="" /> <event timestamp="2019-07-30 02:06:36.1219" action="SUC" actor="475245454E434F000000000001000004" version="20" interface="" object="User - 475245454E434F000000000001000004" outcome="0" context="" /> <event timestamp="2019-07-30 02:06:59.8724" action="SUC" actor="475245454E434F000000000001000004" version="20" interface="" object="User - 475245454E434F000000000001000004" outcome="0" context="" /> <event timestamp="2019-07-30 02:07:36.5505" action="SUC" actor="475245454E434F000000000001000004" version="20" interface="" object="User - 475245454E434F000000000001000004" outcome="0" context="" /> <event timestamp="2019-07-30 02:07:37.8862" action="SUC" actor="475245454E434F000000000001000004" version="20" interface="" object="User - 475245454E434F000000000001000004" outcome="0" context="" /> <event timestamp="2019-07-30 02:08:06.7037" action="SUC" actor="475245454E434F000000000001000004" version="20" interface="" object="User - 475245454E434F000000000001000004" outcome="0" context="" /> <event timestamp="2019-07-30 02:08:10.4557" action="SUC" actor="475245454E434F000000000001000004" version="20" interface="" object="User - 475245454E434F000000000001000004" outcome="0" context="" /> <event timestamp="2019-07-30 02:08:14.8878" action="SUC" actor="475245454E434F000000000001000004" version="20" interface="" object="User - 475245454E434F000000000001000004" outcome="0" context="" /> </audit> </output> </response>
élément de réponse | |||
Nom du marqueur | réponse | ||
Attributs de l'élément | |||
Nom de l'attribut | Obligatoire ? | Valeur | Exemple |
réussite | O | Vrai ou faux, indiquant si l'appel d'API a réussi ou non. Même les appels traités avec succès peuvent contenir des messages d'avertissement dans leur réponse. | vrai |
obsolète | N | S'il figure sur le marqueur de réponse et qu'il est défini sur true (vrai), cet attribut indique que la version de la méthode ou de l'API en cours d'appel est obsolète et qu'elle est actuellement dépréciée. Adaptive Planning . Même si elle continue de fonctionner à ce moment, elle peut cesser de fonctionner prochainement. En général, cet attribut n'est pas présent. | false |
Contenu de l'élément | |||
Un seul élément de messages facultatifs et exactement un élément de sortie obligatoire. | |||
élément de sortie | |
Nom du marqueur | sortie |
Attributs de l'élément | |
(aucun) | |
Contenu de l'élément | |
Un seul élément d'audit. Ce filtre de sortie est standard sur toutes les réponses d'API et contient la sortie valide de tout appel d'API réussi. | |
élément d'audit | |||
Nom du marqueur | audit | ||
Description | Un ensemble d'événements de sécurité. | ||
Attributs de l'élément | |||
(aucun) | |||
Contenu de l'élément | |||
Un ou plusieurs éléments d'événement. | |||
élément d'événement | |||
Nom du marqueur | événement | ||
Description | Un événement de sécurité. | ||
Attributs de l'élément | |||
Nom de l'attribut | Obligatoire ? | Valeur | Exemple |
timestamp | O | L'horodatage au format compatible ISO-8601 ( YYYY-MM-DDTHH:MMSS.ssZ ) au format UTC pour l'événement | 2019-07-30 01:59:48.7781 |
action | O | L'action qui a déclenché l'événement d'audit :
| SUC |
acteur | O | GUID de l'auteur (service, utilisateur, utilisateur système) qui a lancé l'opération et déclenchant l'événement (NULL si aucun utilisateur particulier ne peut être affecté).
Vous pouvez récupérer les noms d'utilisateur actuels par GUID dans les résultats d'un exportUsers appel. | 475245454E434F000000000001000004 |
version | O | Version du logiciel utilisé pour effectuer l'action. | 21 |
interface | N | L'interface (API, IU ou URI) qui déclenche l'événement d'audit. | API |
objet | N | L'objet système qui déclenche l'événement d'audit. | User - 475245454E434F000000000001000004 |
résultat | O | La réussite ou l'échec de l'action. 0 indique la réussite, 1 indique l'échec. | 0 |
context | N | Informations propres au système sur l'événement d'audit. | |
Contenu de l'élément | |||
(aucun) | |||