exportSecurityAudit
Pris en charge dans l'API v20 +
Catégorie
| Extraction de données |
Description
| Renvoie un rapport de tous les événements de sécurité dans un intervalle de temps précisé, pouvant être filtré par type d’événement. Les événements de sécurité incluent les tentatives d’ouverture de session infructueuses, les changements de mot de passe, le verrouillage de compte, la création de comptes et d’autres informations liées à la sécurité. Si aucun intervalle de temps n’est demandé, tous les événements des dernières 24 heures sont retournés. Les événements de sécurité enregistrés par le journal d’audit sont fondés sur la norme NIST 800-53. Adaptive Planning ne conserve que 30 jours de données d’audit de sécurité. |
Autorisations obligatoires pour pouvoir être appelées
| Administrateur |
Paramètres requis sur demande
| Identifiants |
La demande de cette méthode contient un marqueur d’identification pour désigner et autoriser l’utilisateur correspondant, et un marqueur d’inclusion désignant l’acteur et l’intervalle de temps pour lequel récupérer des é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 l’intervalle de temps précisé, pouvant être filtré 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 de données d'identification
| |||
Nom du marqueur
| données d'identification | ||
Description
| Tous les appels d’API doivent contenir un élément d’identification unique pour identifier l’utilisateur qui invoque l’API. L’appel d’API est alors effectué en tant que cet utilisateur (toute piste d’audit ou tout historique des actions dans le système indiquera que cet utilisateur a effectué l’action). Par conséquent, l’utilisateur doit disposer des autorisations requises pour effectuer l’action afin que l’appel d’API puisse être exécuté réussir. | ||
Attributs de l'élément
| |||
Nom de l’attribut
| Obligatoire?
| Valeur
| Exemple
|
ouvrir une session | Y | Le nom de connexion de l’utilisateur qui invoque la méthode API. Cet utilisateur doit disposer des autorisations requises pour invoquer la méthode. | sampleuser@company.com |
mot de passe | Y | Le mot de passe de l’utilisateur qui invoque la méthode API. | my_password |
Contenu de l'élément
| |||
aucun | |||
inclure un é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 récupérer les événements de sécurité. Renvoie des événements pour tous les utilisateurs lorsque l’acteur n’est pas inclus. | stevec@greenco.com |
dateTimeFrom | N | Le début de l’intervalle de temps au format compatible ISO-8601 ( AAAA-MM-JJTH: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 l’intervalle de temps au format compatible ISO-8601 ( AAAA-MM-JJTH: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 | |||
Format de 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 | Y | Vrai ou faux, indiquant si l’appel d’API a réussi ou non. Même les appels réussis peuvent contenir des messages d’avertissement dans leur réponse. | vrai |
obsolète | N | S’il est présent dans le marqueur de réponse et défini à Vrai, cet attribut indique que la version de la méthode ou de l’API qui est appelée est obsolète et est officiellement dépréciée par Adaptive Planning . Bien qu’elle continue de fonctionner pour le moment, elle pourrait cesser de fonctionner sous peu. En général, cet attribut n’est pas présent. | faux |
Contenu de l'élément
| |||
Un seul élément de message facultatif et un seul é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 enveloppe la sortie valide de tout appel d’API réussi. | |
élément d'audit
| |||
Nom du marqueur
| auditer | ||
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 lié à la sécurité. | ||
Attributs de l'élément
| |||
Nom de l’attribut
| Obligatoire?
| Valeur
| Exemple
|
timestamp | Y | L’horodatage au format compatible ISO-8601 ( AAAA-MM-JJTH:MM:SS.sssZ ) en UTC de l’événement | 2019-07-30 01:59:48.7781 |
action | Y | L’action qui a déclenché l’événement d’audit :
| SUC |
acteur | Y | GUID de l’acteur (service, utilisateur, utilisateur système) qui a lancé l’opération déclenchant l’événement (NULL si aucun utilisateur particulier ne peut être affecté).
Vous pouvez récupérer les utilisateurs actuels par GUID dans les résultats d'une exportUsers un appel. | 475245454E434F000000000001000004
|
version | Y | La version du logiciel utilisé pour effectuer l’action. | 21 |
interface | N | L’interface (API, UI 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 | Y | La réussite ou l’échec de l’action. 0 indique une réussite, 1 indique un échec. | 0 |
context | N | L’information propre au système sur l’événement d’audit. | |
Contenu de l'élément
| |||
(aucun) | |||