Página de registro de auditoría en la Management Console de Jitterbit

Introducción

La página Registro de auditoría de la Management Console permite a los administradores de la organización Harmony recuperar registros de la actividad de los usuarios de Harmony que se lleva a cabo en la Management Console, API Manager, y Integration Studio, y usuarios externos accediendo al API Manager Portal página.

Para acceder a la página, inicie sesión en el portal Harmony, luego use el menú del portal Harmony en la parte superior izquierda y navegue a Management Console > Registro de auditoría:

Como alternativa a la visualización de los registros de auditoría en esta página, puede recuperar los registros de auditoría mediante una API REST. La API del servicio de registro de auditoría se describe más adelante en esta página.

Prerrequisitos

Para habilitar y ver los registros de auditoría, debe ser miembro de un rol con permiso Admin en la organización.

Habilitar el registro de auditoría

El control para habilitar o deshabilitar el registro de auditoría se sincroniza en estas dos páginas de la Management Console:

• Esta página: Seleccione Registro de auditoría deshabilitado para activar o Registro de auditoría habilitado para desactivar el registro de auditoría para la currently active organization:

  

  

• Organizations Página: Seleccione la organización adecuada en la tabla. En el cajón Políticas de la organización, seleccione la pestaña Administración de API y, luego, seleccione Habilitar registro de auditoría para activar o desactivar el registro de auditoría para la organización.

Encabezado de la página de registro de auditoría

El encabezado en la parte superior de la página incluye una barra de búsqueda, filtros de fecha y hora y opciones adicionales:

Barra de búsqueda

La barra de búsqueda le permite filtrar los registros según los criterios de búsqueda que se proporcionan a continuación:

Criterios de búsqueda

Las búsquedas se realizan en el key=value formato. Los cinco criterios que se pueden utilizar como claves se muestran con ejemplos en la siguiente tabla:

Combinar búsquedas

Las búsquedas pueden contener una combinación de criterios. Los criterios de búsqueda combinados deben estar separados por un punto y coma (;) entre cada criterio. Estos son ejemplos de búsquedas combinadas válidas:

action=update;environment=production

environmentid=123456;action=create

Filtros de fecha y hora

De manera predeterminada, los datos del registro de auditoría de los últimos dos días se muestran en la tabla de registro de auditoría.

Para cambiar el período, haga clic en el botón Icono de calendario en la barra de rango de fechas:

Se abre un selector de fechas donde puede establecer las fechas de inicio y finalización del período de visualización:

Para restablecer el período al valor predeterminado, haga clic en la barra de rango de fechas icono de reinicio.

Opciones adicionales

A la derecha de los filtros de fecha y hora se encuentran los siguientes controles:

• Actualizar: Actualiza los datos de la tabla.

• Configuración de columnas: Abra el cajón de configuración de columnas:

  

  Use esto para cambiar la disposición y visibilidad de las columnas. El cajón tiene los siguientes controles:

  • Mostrar todo: Hace que todas las columnas sean visibles.
  • Mover: Arrastre y suelte para cambiar la posición de la columna con respecto a otras.
  • Ocultar: La columna está visible. Haz clic para ocultarla.
  • Mostrar: La columna está oculta. Haz clic para mostrarla.
  • Guardar: Guarda las columnas.
  • Cancelar: Cierra el cajón de columnas sin guardar los cambios.

• Descargar: Haga clic para descargar un archivo ZIP que contiene un archivo CSV con los datos del registro de auditoría actual según los filtros y criterios de búsqueda aplicados.

Pie de página de registro de auditoría

Cuando hay más de 100 operaciones, se dividen en páginas de 100 cada una. Puede desplazarse por ellas utilizando estos botones de navegación en la parte inferior de la tabla:

• Primera página: Ir a la primera página.

• Página anterior: Ir a la página anterior.

• Página siguiente: Ir a la página siguiente.

• Última página: Ir a la última página.

Ver registros de auditoría

Cada fila de la tabla de registros de auditoría muestra datos de registro de auditoría de la actividad y los inicios de sesión que tienen lugar en la Management Console, el API Manager y Integration Studio:

• Nombre de usuario: El nombre de usuario del usuario que realiza la actividad.

• Acción: La acción realizada por el usuario, una de las siguientes: Crear, Eliminar, Actualizar o Consultar:

  • Crear: Indica que el usuario creó nuevos datos en el contenido de una página en la Management Console, una API en el API Manager o un proyecto en Integration Studio Por ejemplo, crear un nuevo agente en la Management Console o desplegar un proyecto en Integration Studio Serían acciones Crear.

  • Eliminar: Indica que el usuario eliminó datos del contenido de una página en la Management Console, una API en el API Manager o un proyecto en Integration Studio Por ejemplo, eliminar un agente en la Management Console o eliminar un proyecto de Integration Studio Serían acciones Eliminar.

  • Actualización: Indica que el usuario actualizó el contenido de una página en la Management Console, una API en el API Manager o un proyecto en Integration Studio Por ejemplo, cambiar el nombre de un agente en la Management Console sería una acción de Actualización.

  • Consulta: Indica que el usuario vio el contenido de una página en la Management Console, una API en el API Manager o un proyecto en Integration Studio. Por ejemplo, ver la lista de proyectos en Integration Studio Sería una acción de Consulta.

• Información de la actividad: Cuando se produce una acción de despliegue, esta columna muestra los nombres de las actividades afectadas Integration Studio Proyecto y operación. Cuando se implementa un proyecto, se muestra el nombre del proyecto. Cuando se implementa una sola operación, se muestra el nombre del proyecto que contiene la operación y el nombre de la operación. Cuando se agrega o elimina un perfil de seguridad de API Manager, se muestra el cambio. Cuando se cambia un rol de usuario, se muestra el cambio.

• Hora: La hora de la actividad. Las horas se muestran en la huso horario de tu navegador.

• ID del ambiente: El ID del ambiente o ambientes donde se lleva a cabo la actividad.

• Nombre del ambiente: El nombre del ambiente donde se lleva a cabo la actividad.

• Descripción de la actividad: Una descripción de la actividad. Si no hay ninguna descripción disponible, se muestra la URL del extremo.

API del servicio de registro de auditoría

Como alternativa a la visualización de los registros de auditoría en la página Registro de auditoría de la Management Console, puede recuperar los registros de auditoría mediante una API REST. Esto requiere el uso de utilidades de línea de comandos como curl o aplicaciones como Postman.

Para utilizar la API del servicio de registro de auditoría, después de habilitar el registro de auditoría para la organización (descrita anteriormente en esta página), siga estos pasos:

1. Recupere un token de autenticación mediante la API del controlador de servicio de usuario. Este token es necesario para utilizar la API del servicio de registro de auditoría.

   • Si tu Harmony organización no tiene habilitada la autenticación de dos factores (TFA), recupere su token de autenticación con una solicitud de inicio de sesión estándar.

   • Si tu Harmony organización tiene TFA habilitado, recuperando el token de autenticación requiere dos solicitudes:

     1. Recuperar un código TFA

     2. Usa el código TFA para recuperar un token de autenticación

2. Recuperar registros utilizando la API del servicio de registro de auditoría.

Recuperar un token de autenticación

Para recuperar un token de autenticación se requiere el uso de la API del controlador de servicio de usuario.

Una solicitud de ejemplo que muestra el inicio de sesión en la región NA y la recuperación del token de autorización:

curl --location --request PUT 'https://na-east.jitterbit.com/jitterbit-cloud-restful-service/user/login' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "alice@jbexample.com",
    "password": "Jitterbit4Ever!"
}'

URL base

La URL base depende de la región en la que se encuentra la organización:

Encabezados

Estos encabezados son obligatorios:

Parámetros corporales

Estos parámetros obligatorios se pasan en el cuerpo de la solicitud:

Cuerpo de respuesta

El cuerpo de la respuesta devuelta contiene una lista de las organizaciones con las que está asociado el usuario además del token de autenticación ("authenticationToken"). Este token es necesario para la posterior autorización con la API de registro de auditoría. En este ejemplo, el token de autenticación es "1_70dfe7f7-1d47-4ad5-be5d-bc4a222dd2g4" El ID de la organización se muestra como "123456" Para la primera organización a la que pertenece este usuario. Un ejemplo de la respuesta:

{
  "status": true,
  "operation": "User login",
  "authenticationToken": "1_70dfe7f7-1d47-4ad5-be5d-bc4a222dd2g4",
  "serverUrl": "https://na-east.jitterbit.com",
  "cloudAppsUrl": "https://na-east.jitterbit.com",
  "orgAttrs": [
    {
      "orgId": "123456",
      "orgName": "JB Example Company",
      "orgZoneUrl": "https://na-east.jitterbit.com"
    },
    {
      "orgId": "20970",
      "orgName": "example@jbexample.com",
      "orgZoneUrl": "https://na-east.jitterbit.com"
    }
  ],
  "defaultOrgId": "123456",
  "sessionTimeoutInSeconds": 14400
}

Recuperar un token de autenticación con TFA habilitado

Si la Harmony organización de un usuario tiene habilitada la autenticación de dos factores (TFA), por lo que recuperar el token de autenticación requiere dos solicitudes mediante la API del controlador de servicio de usuario:

1. Recuperar un código TFA

2. Utilice el código TFA para recuperar un token de autenticación

Recuperar un código TFA

Se requiere un código TFA válido para recuperar un token de autenticación cuando TFA está habilitado. Una solicitud de ejemplo que muestra el inicio de sesión en la región NA y la solicitud de un código TFA:

curl --location --request PUT 'https://na-east.jitterbit.com/jitterbit-cloud-restful-service/user/login' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "alice@jbexample.com",
    "password": "Jitterbit4Ever!",
    "deviceId": "abcd"
}'

URL base

La URL base depende de la región en la que se encuentra la organización:

Encabezados

Estos encabezados son obligatorios:

Parámetros corporales

Estos parámetros obligatorios se pasan en el cuerpo de la solicitud:

Cuerpo de respuesta

El cuerpo de la respuesta devuelta contiene un mensaje de error que indica que se envió un código TFA a la dirección de correo del usuario.

{
  "status": false,
  "operation": "User login",
  "errorCode": "VALIDATE_TFA_LOGIN_EMAIL",
  "errorMessage": "Validate your login with authentication code. An email from Jitterbit with the code was sent to you.",
  "authenticationToken": null,
  "serverUrl": "https://na-east.jitterbit.com",
  "orgAttrs": [],
  "defaultOrgId": null
}

Utilice el código TFA para recuperar un token de autenticación

El código TFA enviado a la dirección de correo del usuario ahora se puede utilizar en la segunda solicitud para recuperar el token de autenticación. Una solicitud de ejemplo que muestra el inicio de sesión en la región NA con un código TFA y la recuperación del token de autorización:

curl --location --request PUT 'https://na-east.jitterbit.com/jitterbit-cloud-restful-service/user/login/code' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "alice@jbexample.com",
    "password": "Jitterbit4Ever!",
    "code": "112233"
    "deviceId": "abcd"
}'

URL base

La URL base depende de la región en la que se encuentra la organización:

Encabezados

Estos encabezados son obligatorios:

Parámetros corporales

Estos parámetros obligatorios se pasan en el cuerpo de la solicitud:

Cuerpo de respuesta

El cuerpo de la respuesta devuelta contiene una lista de las organizaciones con las que está asociado el usuario además del token de autenticación ("authenticationToken"). Este token es necesario para la posterior autorización con la API de registro de auditoría. En este ejemplo, el token de autenticación es "1_70dfe7f7-1d47-4ad5-be5d-bc4a222dd2g4" El ID de la organización se muestra como "123456" Para la primera organización a la que pertenece este usuario. Un ejemplo de la respuesta:

{
  "status": true,
  "operation": "User login",
  "authenticationToken": "1_70dfe7f7-1d47-4ad5-be5d-bc4a222dd2g4",
  "serverUrl": "https://na-east.jitterbit.com",
  "cloudAppsUrl": "https://na-east.jitterbit.com",
  "orgAttrs": [
    {
      "orgId": "123456",
      "orgName": "JB Example Company",
      "orgZoneUrl": "https://na-east.jitterbit.com"
    },
    {
      "orgId": "654321",
      "orgName": "example@jbexample.com",
      "orgZoneUrl": "https://na-east.jitterbit.com"
    }
  ],
  "defaultOrgId": "123456",
  "sessionTimeoutInSeconds": 14400
}

Recuperar registros de auditoría

Una vez que tenga el token de autenticación, el ID de la organización y el período de tiempo que le interese, puede recuperar los registros de auditoría. Un ejemplo que muestra cómo recuperar todos los registros a partir del 1 de enero de 2021 e incluye la versión detallada de los registros:

curl --request POST 'https://api.na.jitterbit.com/v1/auditlog?detail=true' \
--header 'accept: application/json' \
--header 'authToken: 1_70dfe7f7-1d47-4ad5-be5d-bc4a222dd2g4' \
--header 'Content-Type: application/json' \
--data-raw '{
    "queryParams": {
        "organization_id": "123456"
    },
    "range": {
        "fromTimestamp": "2021-01-01T00:00:00.000Z",
        "toTimeStamp": "9999-01-01T00:00:00.000Z"
    }
}'

URL base

La URL base depende de la región en la que se encuentra la organización:

Extremos

El servicio de registro de auditoría tiene estos extremos (APIs) disponibles:

Parámetros de URL

Estos parámetros se pueden pasar en la URL:

Encabezados

Estos encabezados se pueden utilizar en la solicitud:

Parámetros corporales

Estos parámetros se pueden pasar en el cuerpo de la solicitud:

Ejemplo

Este ejemplo utiliza el auditlog/download extremo para recuperar todos los registros de la organización 123456, con una acción de QUERY, a partir del 1 de enero de 2023, incluida la versión detallada de los registros, y descargada como CSV en un formato de archivo comprimido (ZIP) a un archivo de salida:

curl --request POST 'https://api.na.jitterbit.com/v1/auditlog/download?detail=true' \
--output 'download.zip' \
--header 'accept: application/zip' \
--header 'authToken: 1_70dfe7f7-1d47-4ad5-be5d-bc4a222dd2g4' \
--header 'Content-Type: application/json' \
--data-raw '{
    "queryParams": {
        "organization_id": "123456",
        "action": "QUERY"
    },
    "range": {
        "fromTimestamp": "2023-01-01T00:00:00.000Z",
        "toTimeStamp": "9999-01-01T00:00:00.000Z"
    }
}'

Ejemplo de salida de registro

Este es un fragmento de ejemplo de la salida JSON devuelta por el auditlog extremo:

{
  "records": [
    {
      "username": "alice@jbexample.com",
      "organization_id": "123456",
      "organization_name": "JB Example Company",
      "operation_name": "/jitterbit-cloud-restful-service/user/login",
      "action": "UPDATE",
      "action_timestamp": "2023-03-23T09:59:59.999Z",
      "environment_ids": null,
      "environment_names": null,
      "sort_values": [
        1680083968484
      ],
      "user_id": null,
      "acitivity_info": null,
      "request_body": "null",
      "response_body": "null"
    },
    {
      "username": "bob@jbexample.com",
      "organization_id": "123456",
      "organization_name": "JB Example Company",
      "operation_name": "/jitterbit-cloud-restful-service/subscription/list/647330",
      "action": "QUERY",
      "action_timestamp": "2023-03-23T08:59:59.999Z",
      "environment_ids": null,
      "environment_names": null,
      "sort_values": [
          1680081692921
      ],
      "user_id": null,
      "acitivity_info": null,
      "request_body": "null",
      "response_body": "{\"subscriptions\":[{\"organizationId\":\"123321\",\"lastUpdatedBy\":\"alice@jbexample.com\",\"offeringName\":\"Jitterbit Harmony Enterprise\",\"activatedOn\":1658343482577,\"createdBy\":\"alice@jbexample.com\",\"displayExpiresOn\":1660934256000,\"lastUpdatedOn\":1658343482660,\"expiresOn\":2607705456000,\"id\":\"125521\",\"createdOn\":1658343482577,\"offeringEnumId\":\"5\"}],\"operation\":\"List Subscription by Organization\",\"status\":true}"
    },
    {
      "username": "bob@jbexample.com",
      "organization_id": "123456",
      "organization_name": "JB Example Company",
      "operation_name": "/jitterbit-cloud-restful-service/project/env/detail/654321",
      "action": "CREATE",
      "action_timestamp": "2023-03-23T07:59:59.999Z",
      "environment_ids": [
          "654321"
      ],
      "environment_names": [
          "Default Environment"
      ],
      "sort_values": [
          1679393229672
      ],
      "user_id": null,
      "acitivity_info": "Project: Salesforce to NetSuite Operation: Get Customers",
      "request_body": "null",
      "response_body": "{\"projEnvDetails\":{\"noOfConnections\":0,\"lastUpdatedBy\":\"alice@jbexample.com\",\"agentClusterId\":1,\"noOfHostedEndPoints\":0,\"appRuntime\":\"sandbox\",\"agentGroupId\":\"99999\",\"urlPrefix\":\"defaultUrlPrefix\",\"permission\":7,\"envId\":\"654321\",\"agentGroupName\":\"Production Cloud Agent Group\",\"lowestAgentVersion\":\"11.0.0.0\",\"createdOn\":1515425638817,\"orgId\":\"123456\",\"noOfScripts\":0,\"noOfProjects\":0,\"createdBy\":\"bob@jbexample.com\",\"envName\":\"Default Environment\",\"envType\":2,\"noOfFileFormats\":0,\"envDesc\":\"Default environment created by Harmony\",\"lastUpdatedOn\":1661335689017,\"noOfOperations\":0},\"operation\":\"Get detail of a Project Env\",\"status\":true}"
    },
. . .
  ]
}