Saltar al contenido principal
Adaptive Planning
Última actualización: 2023-06-23
exportSecurityAudit

exportSecurityAudit

Compatible con API v20 +
Categoría
Recuperación de datos
Descripción
Devuelve un informe de todos los eventos de seguridad en un rango de tiempo especificado, que se puede filtrar por tipo de evento. Los eventos de seguridad incluyen intentos de inicio de sesión fallidos, cambios de contraseña, bloqueo de cuenta, creación de cuenta y otra información relacionada con la seguridad. Si no se solicita ningún rango de tiempo, se devuelven todos los eventos de las últimas 24 horas. Los eventos de seguridad registrados por el registro de auditoría se basan en NIST 800-53. Adaptive Planning solo conserva 30 días de datos de auditoría de seguridad.
Permisos obligatorios para invocar
Administrador
Parámetros obligatorios bajo petición
Credenciales
La solicitud de este método contiene una etiqueta de credenciales para identificar y autorizar al usuario que llama, y una etiqueta de inclusión que identifica el actor y el rango de tiempo para recuperar eventos de seguridad. Una vez verificado, el método devuelve un documento XML que describe todos los eventos de seguridad en el rango de tiempo especificado, que se puede filtrar por tipo de evento.

Formato de solicitud

<?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>
elemento de credenciales
Nombre de etiqueta
credenciales
Descripción
Todas las llamadas a la API deben contener un único elemento de credenciales para identificar al usuario que invoca la API. A continuación, la llamada a la API se realiza como este usuario (cualquier pista de auditoría o historial de acciones en el sistema mostrará que este usuario ha realizado la acción) y, por lo tanto, el usuario debe tener los permisos necesarios para realizar la acción a fin de que la llamada a la API se lleve a cabo. correcta
Atributos del elemento
Nombre de atributo
¿Obligatorio?
Valor
Ejemplo
inicio de sesión
El nombre de conexión del usuario que invoca el método API. Este usuario debe tener los permisos necesarios para invocar el método.
sampleuser@company.com
contraseña
La contraseña del usuario que invoca el método API.
my_password
Contenido del elemento
ninguno
incluir elemento
Nombre de etiqueta
incluir
Descripción
Atributos del elemento
Nombre de atributo
¿Obligatorio?
Valor
Ejemplo
actor
No
El nombre de usuario cuyos eventos de seguridad desea recuperar. Devuelve eventos para todos los usuarios cuando el actor no está incluido.
stevec@greenco.com
dateTimeFrom
No
El inicio del rango de tiempo en formato compatible con ISO-8601 (
YYYY-MM-DDTHH:MM:SS
) en UTC para los eventos de seguridad que desea recuperar.
2019-07-30 00:00:00
dateTimeTo
No
El final del rango temporal en formato compatible con ISO-8601 (
YYYY-MM-DDTHH:MM:SS
) en UTC para los eventos de seguridad que desea recuperar.
2019-07-30 11:59:59
Contenido del elemento
ninguno

Formato de respuesta

<?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>
elemento de respuesta
Nombre de etiqueta
respuesta
Atributos del elemento
Nombre de atributo
¿Obligatorio?
Valor
Ejemplo
éxito
Verdadero o falso, que indica si la llamada a la API se ha realizado correctamente o no. Incluso las llamadas correctas pueden contener mensajes de aviso en su respuesta.
verdadero
obsoleto
No
Si está presente en la etiqueta de respuesta y se establece en verdadero, este atributo indica que la versión del método o API que se está invocando ha quedado obsoleta y está oficialmente desaprobada por
Adaptive Planning
. Aunque sigue funcionando en este momento, es posible que deje de funcionar en un breve periodo de tiempo. Normalmente, este atributo no está presente.
falso
Contenido del elemento
Un único elemento de mensajes opcional y exactamente un elemento de resultado obligatorio.
elemento de resultado
Nombre de etiqueta
salida
Atributos del elemento
(ninguno)
Contenido del elemento
Un solo elemento de auditoría Este contenedor de salida es estándar en todas las respuestas de API e incluye la salida válida de cualquier llamada API correcta.
elemento de auditoría
Nombre de etiqueta
auditoría
Descripción
Una colección de eventos de seguridad.
Atributos del elemento
(ninguno)
Contenido del elemento
Uno o varios elementos de evento
elemento de evento
Nombre de etiqueta
evento
Descripción
Un evento de seguridad
Atributos del elemento
Nombre de atributo
¿Obligatorio?
Valor
Ejemplo
timestamp
La marca de tiempo en formato compatible con ISO-8601 (
YYYY-MM-DDTHH:MM:SS.sssZ
) en UTC del evento
2019-07-30 01:59:48.7781
acción
La acción que activó el evento de auditoría:
  • Creación de cuenta 'CRE'
  • Cuenta "DIS" desactivada
  • Bloqueo de cuenta "LOK"
  • Desbloqueo de cuenta "UOK"
  • Error de inicio de sesión "USC"
  • Inicio de sesión correcto "SUC"
  • Cierre de sesión de usuario "ULO"
  • Cambio de contraseña de usuario "PWC"
  • Finalización de sesión 'TER' debido a excepciones
  • Caducidad de sesión 'EXP'
  • Cambios en la credencial "CRD"
  • 'AUT' Cambios en la configuración de autenticación
SUC
actor
GUID del actor (servicio, usuario, usuario de sistema) que inició la operación que activa el evento (NULL si no se puede asignar ningún usuario en particular).
Puede recuperar los nombres de usuario actuales por GUID en los resultados de una exportUsers llamada
475245454E434F000000000001000004
versión
La versión del software utilizado para realizar la acción.
21
interfaz
No
La interfaz (API, IU o URI) que activa el evento de auditoría.
API
objeto
No
El objeto de sistema que activa el evento de auditoría.
User - 475245454E434F000000000001000004
resultado
El éxito o el fracaso de la acción. 0 indica éxito, 1 indica error.
0
contexto
No
Información específica del sistema sobre el evento de auditoría.
Contenido del elemento
(ninguno)