Página de Registro de Auditoría en la Consola de Administración de Jitterbit

Introducción

La página de Registro de Auditoría de la Consola de Administración 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 Consola de Administración, API Manager, y Integration Studio, así como de usuarios externos que acceden a la página del Portal del API Manager.

Para acceder a la página, utiliza el menú del portal Harmony para seleccionar Consola de Administración > Registro de Auditoría.

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

Requisitos Previos

Para habilitar y ver los registros de auditoría, debes ser miembro de un rol con Permiso de Administrador en la organización.

Habilitar el registro de auditoría

El control para habilitar o deshabilitar el registro de auditoría está sincronizado en estas dos páginas de la Consola de Administración:

• Esta página: Selecciona Registro de Auditoría Desactivado para activar o Registro de Auditoría Activado para desactivar el registro de auditoría para la [organización actualmente activa]:

  

  

• Página de [Organizaciones]: Selecciona la organización apropiada en la tabla. En el panel de Políticas de Organización, selecciona la pestaña Gestión de API, luego selecciona 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 permite filtrar los registros según los criterios de búsqueda proporcionados a continuación:

Criterios de búsqueda

Las búsquedas se realizan en el formato key=value. Los cinco criterios que se pueden usar como claves se muestran con ejemplos en la tabla a continuación:

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

Por defecto, 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 ícono de calendario en la barra de rango de fechas:

Se abre un selector de fecha donde puede establecer las fechas de inicio y fin para el período de visualización, utilizando rangos de fechas relativos o absolutos:

Para restablecer el período a los valores predeterminados, haz clic en el ícono de restablecimiento de la barra de rango de fechas.

La configuración regional de tu navegador determina cómo se muestran las fechas.

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: Abre el panel de configuración de columnas:

  

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

  • Mostrar todo: Hace visibles todas las columnas.
  • Mover: Arrastra y suelta para cambiar la posición de la columna en relación con las demás.
  • Ocultar: La columna es visible. Haz clic para ocultarla.
  • Mostrar: La columna está oculta. Haz clic para mostrarla.
  • Guardar: Guarda las columnas.
  • Cancelar: Cierra el panel de columnas sin guardar cambios.

• Descargar: Haz clic para descargar un archivo ZIP que contiene un archivo CSV con los datos actuales del registro de auditoría basados en 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. Puedes navegar a través de 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 en la tabla de registros de auditoría muestra datos de registro de auditoría de actividades e inicios de sesión que tienen lugar en la Consola de Administración, API Manager y Integration Studio:

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

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

  • Crear: Indica que el usuario creó nuevos datos en el contenido de una página en la Consola de Administración, una API en el Administrador de API o un proyecto en el Estudio de Integración. Por ejemplo, crear un nuevo agente en la Consola de Administración o desplegar un proyecto en el Estudio de Integración serían acciones de Crear.

  • Eliminar: Indica que el usuario eliminó datos del contenido de una página en la Consola de Administración, una API en el Administrador de API o un proyecto en el Estudio de Integración. Por ejemplo, eliminar un agente en la Consola de Administración o eliminar un proyecto del Estudio de Integración serían acciones de Eliminar.

  • Actualizar: Indica que el usuario actualizó el contenido de una página en la Consola de Administración, una API en el Administrador de API o un proyecto en el Estudio de Integración. Por ejemplo, cambiar el nombre de un agente en la Consola de Administración sería una acción de Actualizar.

  • Consultar: Indica que el usuario vio el contenido de una página en la Consola de Administración, una API en el Administrador de API o un proyecto en el Estudio de Integración. Por ejemplo, ver la lista de proyectos en el Estudio de Integración sería una acción de Consultar.

• Información de actividad: Cuando ocurre una acción de despliegue, esta columna muestra los nombres del proyecto y la operación del Estudio de Integración afectados. Cuando se despliega un proyecto, se muestra el nombre del proyecto. Cuando se despliega 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 se elimina un perfil de seguridad en el Administrador de API, se muestra el cambio. Cuando se cambia un rol de usuario, se muestra el cambio.

• Hora: La marca de tiempo de la actividad. Las horas se muestran en la zona horaria de su navegador.

• ID de entorno: El ID del entorno o entornos donde tiene lugar la actividad.

• Nombre de entorno: El nombre del entorno donde tiene lugar la actividad.

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

API del servicio de registro de auditoría

Como alternativa a la visualización de registros de auditoría en la página Registro de Auditoría de la Consola de Administración, se pueden recuperar registros de auditoría utilizando 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 (descrito anteriormente en esta página), sigue estos pasos:

1. Recupera un token de autenticación utilizando 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 organización de Harmony no tiene habilitada la autenticación de dos factores (TFA), recupera tu token de autenticación con una solicitud de inicio de sesión estándar.

   • Si tu organización de Harmony tiene habilitada la TFA, recuperar el token de autenticación requiere dos solicitudes:

     1. Recuperar un código TFA

     2. Usar 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

Recuperar un token de autenticación requiere el uso de la API del Controlador de Servicio de Usuario.

Un ejemplo de solicitud 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 requeridos:

Parámetros del cuerpo

Estos parámetros requeridos se envían en el cuerpo de la solicitud:

Cuerpo de la respuesta

El cuerpo de la respuesta devuelta contiene una lista de las organizaciones con las que el usuario está asociado, además del token de autenticación ("authenticationToken"). Este token es necesario para la autorización subsiguiente 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 organización de un usuario en Harmony tiene habilitada la autenticación de dos factores (TFA), recuperar el token de autenticación requiere dos solicitudes utilizando la API del Controlador de Servicio de Usuario:

1. Recuperar un código TFA

2. Usar 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. Un ejemplo de solicitud 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

Se requieren estos encabezados:

Parámetros del cuerpo

Estos parámetros requeridos se envían en el cuerpo de la solicitud:

Cuerpo de la 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 electrónico 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
}

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

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

curl --location --request PUT 'https://na-east.jitterbit.com/jitterbit-cloud-restful-service/user/login/tfacode' \
--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 requeridos:

Parámetros del cuerpo

Estos parámetros requeridos se envían en el cuerpo de la solicitud:

Cuerpo de la respuesta

El cuerpo de la respuesta devuelta contiene una lista de las organizaciones con las que el usuario está asociado, además del token de autenticación ("authenticationToken"). Este token es necesario para la autorización subsiguiente 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 un período de tiempo de interés, puede recuperar los registros de auditoría. Un ejemplo que muestra la recuperación de todos los registros que comienzan el 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:

Puntos finales

El Servicio de Registro de Auditoría tiene estos puntos finales (APIs) disponibles:

Parámetros de URL

Estos parámetros se pueden pasar en la URL:

Encabezados

Estos encabezados se pueden usar en la solicitud:

Parámetros del cuerpo

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

Ejemplo

Este ejemplo utiliza el endpoint auditlog/download para recuperar todos los registros de la organización 123456, con una acción de QUERY, comenzando a partir del 1 de enero de 2023, incluyendo la versión detallada de los registros, y descargados 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"
    }
}'

Fragmento de salida del registro de ejemplo

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

{
  "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}"
    },
. . .
  ]
}