Módulo data_models

Este módulo contiene clases de datos para representar lo siguiente:

  • Modelos de datos
  • Alertas
  • Contenedores de variables
  • Parámetros generales
  • Parámetros del conector

class TIPCommon.data_models.AlertCard

clase TIPCommon.data_models.AlertCard(id_: int, creation_time_unix_time_ms: int, modification_time_unix_time_ms: int, identifier: str, status: int, name: str, priority: [AlertPriority](#TIPCommon.data_models.AlertPriority) | int | None, workflow_status: int | None, sla_expiration_unix_time: int | None, sla_critical_expiration_unix_time: int | None, start_time: int, end_time: int, alert_group_identifier: str, events_count: int, title: str, rule_generator: str, device_product: str, device_vendor: str, playbook_attached: bool | None, playbook_run_count: int | None, is_manual_alert: bool | None, sla: [SLA](#TIPCommon.data_models.SLA) | None, fields_groups: list[[FieldsGroup](#TIPCommon.data_models.FieldsGroup)], source_url: str | None, source_rule_url: str | None, siem_alert_id: str | None, additional_properties: str | None, case_id: int | None, ticket_id: str | None, closure_details: MutableMapping[str, Any] | None, event_count: int | None = None, product_families: list[str] | None = None, entity_cards: list[MutableMapping[str, Any]] | None = None, security_event_cards: list[MutableMapping[str, Any]] | None = None, involved_relations: list[MutableMapping[str, Any]] | None = None)

Bases: object

AlertCard representa una tarjeta de resumen para una alerta, que encapsula metadatos críticos e indicadores de estado que se usan para la visualización y el seguimiento dentro de la plataforma.

Métodos

Los siguientes métodos facilitan la serialización y la reconstrucción de tarjetas de alerta a partir de datos estructurados.

Métodos
from_json()

from_json(alert_card_json: dict[str, Any]) → AlertCard

Es un método de clase que crea una instancia de AlertCard a partir de un diccionario JSON.

to_json()

to_json() → MutableMapping[str, Any]

Convierte el objeto AlertCard en un formato de diccionario serializable en JSON.

Atributos

En la siguiente tabla, se destacan los principales atributos estructurales y los modelos de datos complejos asociados con la alerta.

Atributos
fields_groups

list[FieldsGroup]

Es una lista de campos agrupados asociados con la alerta, que se usa para la presentación de datos estructurados en la IU.

sla

SLA

Objeto del Acuerdo de Nivel de Servicio que define los plazos de respuesta y resolución de la alerta.

class TIPCommon.data_models.AlertEvent

clase TIPCommon.data_models.AlertEvent(fields: list[EventPropertyField], identifier: str, case_id: int, alert_identifier: str, name: str, product: str, port: str | None, source_system_name: str, outcome: str | None, time: int, type_: str, artifact_entities: list[str])

Bases: object

AlertEvent representa un evento individual asociado con una alerta, que contiene datos de telemetría específicos, propiedades de campos y relaciones de entidades.

Métodos

El siguiente método fƒconacilitates la reconstrucción de objetos de eventos a partir de datos JSON estructurados.

Métodos
from_json()

from_json(event_json: MutableMapping[str, Any]) → AlertEvent

Es un método de clase que crea una instancia de AlertEvent a partir de un diccionario JSON que representa sus atributos.

Atributos

En la siguiente tabla, se destacan los atributos estructurales principales y los modelos de datos complejos asociados con el evento.

Atributos
fields

list[EventPropertyField]

Es una lista de campos de propiedad específicos del evento que definen sus puntos de datos únicos.

artifact_entities

list[str]

Es una lista de identificadores de entidades extraídos de la telemetría del evento.

class TIPCommon.data_models.AlertPriority

clase TIPCommon.data_models.AlertPriority(value)

Bases: Enum

AlertPriority define los niveles de gravedad estandarizados basados en números enteros que se usan para categorizar y priorizar las alertas dentro de la plataforma.

Constantes

Las siguientes constantes representan los valores de prioridad específicos asignados a las alertas.

Constantes
CRITICAL 100
HIGH 80
MEDIUM 60
LOW 40
UNCHANGED 0
INFORMATIVE -1

class TIPCommon.data_models.AttachmentMetadata

clase TIPCommon.data_models.AttachmentMetadata(raw_data: SingleJson)

Bases: object

AttachmentMetadata encapsula los datos descriptivos y las propiedades asociados con un archivo adjunto, y proporciona métodos para la recuperación y conversión de datos estructurados.

Métodos

El siguiente método proporciona una forma estandarizada de reconstruir objetos de casos a partir de cargas útiles de JSON.

Métodos
from_json()

from_json(result_data: MutableMapping[str, Any]) → Self

Es un método de clase que inicializa una nueva instancia de AttachmentMetadata con un diccionario proporcionado de propiedades de metadatos.

to_json()

to_json() → MutableMapping[str, Any]

Serializa el objeto AttachmentMetadata en un formato de diccionario compatible con JSON.

Atributos

En la siguiente tabla, se destacan las estructuras de datos principales que se usan para almacenar las propiedades de metadatos del adjunto.

Atributos
raw_data

MutableMapping[str, Any]

Diccionario subyacente que contiene los atributos de metadatos sin procesar tal como se recibieron de la fuente.

class TIPCommon.data_models.BaseAlert

clase TIPCommon.data_models.BaseAlert(raw_data, alert_id)

Bases: object

BaseAlert es un modelo fundamental que representa una alerta de seguridad genérica. Proporciona una estructura estandarizada para almacenar datos de telemetría sin procesar junto con un identificador de plataforma único.

Métodos

El siguiente método permite serializar la alerta en un formato estándar.

Métodos
to_json()

to_json() → dict[str, Any]

Convierte la alerta en un diccionario serializable en JSON, como lo devuelve json.loads().

Atributos

En la siguiente tabla, se destacan los principales puntos de datos que administra este modelo.

Atributos
raw_data

dict[str, Any]

Es la carga útil de datos sin procesar asociada con la alerta.

alert_id

Any

Es el identificador único asignado a la alerta.

Ejemplo

En el siguiente ejemplo, se muestra cómo inicializar un BaseAlert y acceder a sus datos sin procesar y a su salida serializada.

>>> from data_models import BaseAlert
>>> alert = BaseAlert({'foo': 'bar'}, 100)
>>> alert.raw_data
{'foo': 'bar'}
>>> alert.alert_id
100
>>> alert.to_json()
{'foo': 'bar'}

class TIPCommon.data_models.BaseDataModel

clase TIPCommon.data_models.BaseDataModel(raw_data)

Bases: object

BaseDataModel actúa como clase principal para varias estructuras de datos dentro de la biblioteca, lo que garantiza un manejo coherente de los datos de entrada sin procesar y la serialización.

Métodos

El siguiente método garantiza que los datos sin procesar se recuperen en un formato compatible con las operaciones de JSON.

Métodos
to_json()

to_json() → dict[str, Any]

Serializa los datos sin procesar almacenados en el modelo en un formato de diccionario.

Atributos

En la siguiente tabla, se describe el almacenamiento de datos principal para el modelo base.

Atributos
raw_data

dict[str, Any]

Es la carga útil de datos sin procesar original que se usó para inicializar el modelo.

Ejemplo

En el siguiente ejemplo, se muestra la inicialización básica del modelo de datos y el uso del método de serialización.

>>> from data_models import BaseDataModel
>>> data = BaseDataModel({'foo': 'bar'})
>>> data.raw_data
{'foo': 'bar'}
>>> data.to_json()
{'foo': 'bar'}

class TIPCommon.data_models.CaseDataStatus

clase TIPCommon.data_models.CaseDataStatus(value)

Bases: Enum

CaseDataStatus define los estados operativos admitidos para los casos dentro de la plataforma, desde la incorporación inicial hasta el cierre o la combinación final.

Constantes

Las siguientes constantes representan los indicadores de estado específicos asignados a los datos de casos.

Constantes
NEW 0
OPENED 1
CLOSED 2
ALL 3
MERGED 4
CREATION_PENDING 5

class TIPCommon.data_models.CaseDetails

Bases: object

CaseDetails proporciona una vista extensa de un caso de seguridad, incluidas las propiedades de verificación de estado y los métodos para reconstruir o serializar los datos del caso.

Métodos

Los siguientes métodos administran la conversión de los detalles del caso entre instancias de objetos y formatos JSON estructurados.

Métodos
from_json()

from_json(case_details_json: MutableMapping[str, Any]) → CaseDetails

Es un método de clase que inicializa una instancia de CaseDetails a partir de un diccionario de atributos de caso.

to_json()

to_json(include_activities: bool = False) → MutableMapping[str, Any]

Convierte el objeto CaseDetails en un diccionario serializable en JSON. Configura include_activities como True para incluir los registros de actividad del caso.

Atributos

Las siguientes propiedades proporcionan indicadores lógicos sobre el estado actual del caso.

Atributos
is_closed

bool

Es una propiedad booleana que indica si el estuche está cerrado.

is_open

bool

Es una propiedad booleana que indica si el caso está activo o abierto.

class TIPCommon.data_models.CaseOverviewInfo

clase TIPCommon.data_models.CaseOverviewInfo(id: 'int', create_time_ms: 'int', update_time_ms: 'int', display_id: 'str', display_name: 'str', alert_count: 'int', stage: 'str', priority: 'CasePriority', important: 'bool', description: 'str | None' = None, type: 'int | None' = None, assignee_full_name: 'str | None' = None, environment_data: 'EnvironmentData | None' = None, status: 'CaseDataStatus | None' = None, score: 'int | None' = None, case_sla: 'CaseSLAInfo | None' = None, alerts_sla: 'CaseSLAInfo | None' = None, incident: 'bool | None' = None, has_suspicious_entity: 'bool | None' = None, workflow_status: 'int | None' = None, tags: 'list[str]' = <factory>, products: 'list[str]' = <factory>, touched: 'bool | None' = None, merged: 'bool | None' = None, has_incident: 'bool | None' = None, alert_names: 'list[str]' = <factory>)

Bases: object

CaseOverviewInfo proporciona un resumen de alto nivel de un caso de seguridad, ya que agrega metadatos, el estado del Acuerdo de Nivel de Servicio (ANS) y detalles organizacionales que se usan para la administración de colas y la generación de paneles.

Métodos

El siguiente método facilita la reconstrucción de objetos de resumen del caso a partir de datos JSON estructurados.

Métodos
from_json()

from_json(json_data: MutableMapping[str, Any]) → CaseOverviewInfo

Es un método de clase que inicializa una instancia de CaseOverviewInfo a partir de un diccionario de atributos de resumen del caso.

Atributos

En la siguiente tabla, se destacan los principales atributos estructurales, enumeraciones y métricas operativas clave asociados con el resumen del caso.

Atributos
priority

CasePriority

Es el nivel de gravedad asignado al caso.

status

CaseDataStatus | None

Es el estado operativo actual de los datos del caso.

workflow_status

int | None

Paso o estado actual dentro del motor de flujo de trabajo automatizado de la plataforma.

score

int | None

Es la puntuación de riesgo o importancia calculada que se asigna al caso.

case_sla

CaseSLAInfo | None

Es información de seguimiento del ANS específica para el ciclo de vida de la resolución de casos.

alerts_sla

CaseSLAInfo | None

Es la información de seguimiento del ANS para las alertas individuales incluidas en el caso.

environment_data

EnvironmentData | None

Son los metadatos relacionados con el entorno organizacional específico en el que se originó el caso.

tags

list[str]

Es una lista de etiquetas definidas por el usuario o generadas por el sistema asociadas con el caso.

class TIPCommon.data_models.CasePriority

clase TIPCommon.data_models.CasePriority(value)

Bases: Enum

CasePriority define los niveles de gravedad estandarizados basados en números enteros que se usan para categorizar y priorizar los casos dentro de la plataforma.

Constantes

Las siguientes constantes representan los valores de prioridad específicos asignados a los casos.

Constantes
CRITICAL 100
HIGH 80
MEDIUM 60
LOW 40
UNCHANGED 0
INFORMATIVE -1

class TIPCommon.data_models.CaseSLAInfo

clase TIPCommon.data_models.CaseSLAInfo(expiration_time_ms: int | None = None, critical_expiration_time_ms: int | None = None, expiration_status: int | None = None, last_pause_remaining_time_ms: int | None = None)

Bases: object

CaseSLAInfo encapsula los datos de seguimiento del Acuerdo de Nivel de Servicio (ANS), ya que proporciona marcas de tiempo para la fecha de vencimiento y los indicadores de estado para garantizar una respuesta oportuna ante incidentes.

Métodos

El siguiente método permite crear objetos de información del ANS a partir de datos JSON estructurados.

Métodos
from_json()

from_json(json_data: MutableMapping[str, Any]) → CaseSLAInfo

Es un método de clase que inicializa una instancia de CaseSLAInfo a partir de un diccionario de atributos del ANS.

Atributos

En la siguiente tabla, se destacan los principales atributos de tiempo y estado que se usan para supervisar los plazos de los casos.

Atributos
expiration_time_ms

int | None

Es la marca de tiempo de Unix (en milisegundos) en la que vence el SLA estándar.

critical_expiration_time_ms

int | None

Es la marca de tiempo de Unix (en milisegundos) en la que se alcanza el umbral crítico del ANS.

expiration_status

int | None

Es un indicador entero que representa el estado actual del ANS.

last_pause_remaining_time_ms

int | None

Es la cantidad de tiempo restante en el reloj del ANS en el momento en que se pausó por última vez.

class TIPCommon.data_models.CaseWallAttachment

clase TIPCommon.data_models.CaseWallAttachment(name, file_type, base64_blob, is_important, case_id=None, description=None)

Bases: object

CaseWallAttachment representa un archivo o un objeto de datos adjunto al muro de evidencia de un caso, incluido el contenido sin procesar en formato base64 y los metadatos asociados.

Atributos

En la siguiente tabla, se destacan las propiedades principales y los datos de contenido asociados con el adjunto.

Atributos
name

str

Nombre de archivo o nombre visible del archivo adjunto.

file_type

str

Tipo de MIME o extensión de archivo que indica el formato de los datos adjuntos.

base64_blob

str

Es el contenido real del archivo, codificado como una cadena base64.

is_important

bool

Es una marca que indica si el adjunto está marcado como evidencia crítica para la investigación.

class TIPCommon.data_models.ConnectorCard

clase TIPCommon.data_models.ConnectorCard(integration, display_name, identifier, is_enabled, is_remote, status)

Bases: object

ConnectorCard proporciona un resumen de la configuración de un conector específico y

estado operativo actual dentro de la plataforma.

Métodos

El siguiente método facilita la creación de instancias de tarjetas de conector a partir de datos JSON estructurados.

Métodos
from_json()

from_json(connector_card_json: MutableMapping[str, Any]) → ConnectorCard

Es un método de clase que inicializa una instancia de ConnectorCard a partir de un diccionario de atributos del conector.

Atributos

En la siguiente tabla, se destacan el estado operativo y las propiedades de identificación del conector.

Atributos
status

ConnectorConnectivityStatusEnum

Estado actual de conectividad y estado del conector.

is_enabled

bool

Indica si el conector está activo y procesando datos.

class TIPCommon.data_models.ConnectorConnectivityStatusEnum

clase TIPCommon.data_models.ConnectorConnectivityStatusEnum(value)

Bases: Enum

ConnectorConnectivityStatusEnum define los posibles estados de conectividad de un conector, lo que indica si se comunica correctamente con su integración de destino.

Constantes

Las siguientes constantes representan el estado de la conexión del conector.

Constantes
LIVE 0
NO_CONNECTIVITY 1

class TIPCommon.data_models.ConnectorParamTypes

clase TIPCommon.data_models.ConnectorParamTypes(value)

Bases: Enum

ConnectorParamTypes define los tipos de datos admitidos para los parámetros de configuración del conector. Estos tipos garantizan la validación adecuada y la renderización de la IU en la configuración de la plataforma.

Constantes

Las siguientes constantes representan los tipos de datos específicos disponibles para los parámetros.

Constantes
BOOLEAN 0 (botón de activación booleano)
INTEGER 1 (número entero)
STRING 2 (cadena de texto estándar)
PASSWORD 3 (campo de contraseña enmascarada)
IP 4 (dirección IP)
HOST 5 (nombre de host)
URL 6 (cadena de URL)
DOMAIN 7 (nombre de dominio)
EMAIL 8 (dirección de correo electrónico)
SCRIPT 12 (parámetro de secuencia de comandos heredado)
NULL -1 (tipo de parámetro no válido)

class TIPCommon.data_models.ConnectorParameter

clase TIPCommon.data_models.ConnectorParameter(raw_param)

Bases: Parameter

ConnectorParameter representa un parámetro de configuración individual para un conector. Extiende el modelo de parámetros base para incluir metadatos específicos, como tipos de validación y requisitos obligatorios.

Atributos

Las siguientes propiedades proporcionan acceso a los detalles y las restricciones de configuración del parámetro del conector.

Atributos
name

str

Es el nombre único que se usa para identificar el parámetro dentro de la configuración del conector.

value

Any

Es el valor actual asignado al parámetro.

type

ConnectorParamTypes

Es el tipo de datos del parámetro, que se usa para la validación y la renderización de la IU.

mode

int

Es el modo operativo o el parámetro de configuración de visibilidad.

is_mandatory

bool

Indica si se debe proporcionar un valor para este parámetro antes de que se guarde o ejecute el conector.

Ejemplo

En el siguiente ejemplo, se muestra cómo inicializar un ConnectorParameter con un diccionario sin procesar y acceder a sus propiedades.

>>> from data_models import ConnectorParameter, ConnectorParamTypes
>>> p = ConnectorParameter({
    'param_name': 'api_root',
    'type': ConnectorParamTypes.STRING,
    'param_value': '[http://foo.bar](http://foo.bar)',
    'is_mandatory': True,
    'mode': 0
    })
>>> print(p)
ConnectorParameter(name='api_root', value='[http://foo.bar](http://foo.bar)', type=2, mode=0, is_mandatory=True)

class TIPCommon.data_models.Container

clase TIPCommon.data_models.Container()

Bases: object

Container actúa como un objeto genérico y dinámico para almacenar variables como atributos. Es útil para pasar colecciones de datos arbitrarias entre diferentes componentes de la plataforma.

Ejemplo

En el siguiente ejemplo, se muestra cómo inicializar un contenedor y asignar y recuperar una variable de forma dinámica.

>>> from data_models import Container
>>> container = Container()
>>> container.one = 1
>>> container.one
1

class TIPCommon.data_models.CreateEntity

clase TIPCommon.data_models.CreateEntity(case_id, alert_identifier, entity_type, entity_identifier, entity_to_connect_regex, types_to_connect=None, is_primary_link=False, is_directional=False)

Bases: object

CreateEntity encapsula las instrucciones necesarias para crear y vincular una nueva entidad a un caso y una alerta existentes. Incluye lógica para la conexión y la asignación de relaciones basadas en expresiones regulares.

Métodos

El siguiente método controla la conversión de instrucciones de creación de entidades en un formato compatible con la plataforma.

Métodos
to_json()

to_json() → MutableMapping[str, Any]

Convierte el objeto CreateEntity en un diccionario serializable en JSON.

Atributos

En la siguiente tabla, se destacan las propiedades principales que se usan para definir la nueva entidad y sus relaciones dentro de la plataforma.

Atributos
case_id

int

Es el identificador único del caso en el que se creará la entidad.

alert_identifier

str

Es el identificador de la alerta con la que se asocia esta entidad.

entity_type

str

Es la clasificación de la entidad.

entity_identifier

str

Es el valor o nombre específico que identifica la entidad.

entity_to_connect_regex

str

Es una expresión regular que se usa para identificar otras entidades a las que se puede conectar esta.

types_to_connect

list[str] | None

Es una lista específica de tipos de entidades aptas para la conexión según la expresión regular.

bool

Indica si esta conexión representa la relación principal entre las entidades.

is_directional

bool

Determina si la conexión tiene una dirección definida (del origen al destino) o es recíproca.

class TIPCommon.data_models.CustomField

clase TIPCommon.data_models.CustomField(id, display_name, description, type, scopes)

Bases: object

CustomField representa un campo de datos definido por el usuario dentro de la plataforma. Permite extender los modelos de datos estándar agregando metadatos específicos adaptados a los requisitos de la organización.

Métodos

El siguiente método permite reconstruir objetos de campos personalizados a partir de datos JSON estructurados.

Métodos
from_json()

from_json(json_data: MutableMapping[str, Any]) → CustomField

Es un método de clase que inicializa una instancia de CustomField a partir de un diccionario de atributos de campo.

Atributos

En la siguiente tabla, se destacan las propiedades principales y las restricciones de alcance del campo personalizado.

Atributos
id

int

Es el identificador único del campo personalizado.

display_name

str

Es la etiqueta legible que se muestra en la IU de la plataforma.

type

str

Es el tipo de datos del campo.

scopes

list[CustomFieldScope]

Es una lista de las áreas de aplicación en las que está disponible este campo.

class TIPCommon.data_models.CustomFieldScope

clase TIPCommon.data_models.CustomFieldScope(value)

Bases: Enum

CustomFieldScope define los objetivos válidos en los que se aplica un campo personalizado dentro de la jerarquía de la plataforma.

Métodos

El siguiente método proporciona una utilidad para resolver la ruta del objeto con alcance.

Métodos
build_parent_path()

build_parent_path(identifier: int) → str

Construye la ruta de acceso interna de la plataforma para el identificador del objeto principal especificado.

Constantes

Las siguientes constantes representan los alcances específicos disponibles para los campos personalizados.

Constantes
ALERTS 'Alert'
CASE 'Case'

class TIPCommon.data_models.CustomFieldValue

clase TIPCommon.data_models.CustomFieldValue(custom_field_id, values, scope, identifier)

Bases: object

CustomFieldValue representa los datos específicos asignados a una instancia de campo personalizado. Vincula la definición del campo con el contenido real que proporciona un usuario o un proceso automatizado.

Métodos

El siguiente método facilita la reconstrucción de los valores de los campos personalizados a partir de datos JSON estructurados.

Métodos
from_json()

from_json(json_data: MutableMapping[str, Any]) → CustomFieldValue

Es un método de clase que inicializa una instancia de CustomFieldValue a partir de un diccionario de atributos de valor.

Atributos

En la siguiente tabla, se destacan las propiedades principales y los identificadores contextuales del valor del campo personalizado.

Atributos
custom_field_id

int

Es el identificador de la definición de CustomField a la que pertenece este valor.

values

list[str]

Es una lista de cadenas que representan los datos reales almacenados en el campo.

scope

CustomFieldScope

Es el área de aplicación en la que se aplica este valor específico.

identifier

int

Es el identificador único del objeto específico que contiene este valor.

class TIPCommon.data_models.DataAccessContext

clase TIPCommon.data_models.DataAccessContext(global_access, assigned_scopes)

Bases: object

DataAccessContext define los permisos y las restricciones de visibilidad para un usuario o proceso, y determinan a qué permisos de datos se puede acceder durante la ejecución.

Métodos

Los siguientes métodos administran la conversión de datos del contexto de acceso entre instancias de objetos y formatos JSON.

Métodos
from_json()

from_json(json_data: MutableMapping[str, Any]) → DataAccessContext

Es un método de clase que inicializa una instancia de DataAccessContext a partir de un diccionario de propiedades de acceso.

to_json()

to_json() → dict

Convierte el objeto DataAccessContext en un formato de diccionario.

Atributos

En la siguiente tabla, se destacan los principales controles de acceso definidos en el contexto.

Atributos
global_access

bool

Indica si el contexto permite el acceso sin restricciones a todos los permisos de datos.

assigned_scopes

list[Any]

Es una lista de los alcances o las unidades organizativas específicos a los que se otorgó acceso de forma explícita.

class TIPCommon.data_models.DatabaseContextType

clase TIPCommon.data_models.DatabaseContextType(value)

Bases: Enum

DatabaseContextType especifica el contexto operativo para las interacciones de la base de datos, lo que garantiza que los datos se conserven o recuperen del segmento lógico correcto de la plataforma.

Constantes

Las siguientes constantes representan las áreas específicas de la plataforma en las que se producen operaciones de bases de datos.

Constantes
GLOBAL 0 (contexto global en todo el sistema)
CASE 1 (contexto de caso de seguridad específico)
ALERT 2 (contexto de alerta individual)
JOB 3 (trabajo programado o contexto de automatización)
CONNECTOR 4 (contexto del conector de datos)

class TIPCommon.data_models.DynamicParameter

clase TIPCommon.data_models.DynamicParameter(key: str, value: str)

Bases: object

DynamicParameter representa un par clave-valor flexible que se usa para pasar la configuración del tiempo de ejecución o los metadatos personalizados entre los componentes del sistema.

Métodos

El siguiente método controla la reconstrucción de parámetros dinámicos a partir de datos JSON estructurados.

Métodos
from_json()

from_json(json_data: MutableMapping[str, Any]) → DynamicParameter

Es un método de clase que inicializa una instancia de DynamicParameter a partir de un diccionario de propiedades de clave y valor.

Atributos

En la siguiente tabla, se describen las propiedades del parámetro dinámico.

Atributos
key

str

Es el nombre o identificador del parámetro.

value

str

Es el contenido de datos asociado a la clave.

class TIPCommon.data_models.EmailTemplate

clase TIPCommon.data_models.EmailTemplate(template_type, name, content, creator_user_name, for_migration, environments, _id, creation_time_unix_time_in_ms, modification_time_unix_time_in_ms)

Bases: object

EmailTemplate representa un formato de comunicación estandarizado que se usa para las notificaciones y los informes dentro de la plataforma. Encapsula el contenido, los metadatos y las restricciones ambientales del mensaje.

Métodos

Los siguientes métodos administran la serialización y la reconstrucción de plantillas de correo electrónico.

Métodos
from_json()

from_json(data: MutableMapping[str, Any]) → EmailTemplate

Es un método de clase que inicializa una instancia de EmailTemplate a partir de un diccionario que contiene datos de la plantilla.

to_json()

to_json() → dict

Convierte el objeto EmailTemplate en un formato de diccionario serializable en JSON.

Atributos

En la siguiente tabla, se destacan las propiedades principales y los datos estructurales de la plantilla de correo electrónico.

Atributos
content

str

Es el texto del cuerpo o la estructura HTML de la plantilla de correo electrónico.

environments

list[str]

Es una lista de los entornos organizacionales en los que esta plantilla está disponible para su uso.

template_type

int | str

Es la clasificación o categoría de la plantilla.

class TIPCommon.data_models.Entity

clase TIPCommon.data_models.Entity(raw_data, case_id, entity_type, enriched, artifact, vulnerable, suspicious, attacker, pivot, internal, manually_created, fields)

Bases: object

Entidad representa un observable o un objeto de interés específico dentro de un caso de seguridad (como una dirección IP, un hash de archivo o un usuario). Realiza un seguimiento de la telemetría sin procesar y de varias "etiquetas" booleanas que indican el rol o el nivel de riesgo de la entidad en la investigación.

Métodos

Los siguientes métodos administran la serialización y la reconstrucción de objetos de entidades.

Métodos
from_json()

from_json(entity_response: MutableMapping[str, Any]) → Entity

Es un método de clase que inicializa una instancia de Entity a partir de un diccionario que contiene telemetría y marcas de entidades.

to_json()

to_json() → MutableMapping[str, Any]

Convierte el objeto Entity en un formato de diccionario serializable en JSON.

Atributos

En la siguiente tabla, se destacan las marcas de clasificación principales y las estructuras de datos asociadas con la entidad.

Atributos
entity_type

str | None

Es la categoría de la entidad.

suspicious

bool

Indica si la entidad se marcó como potencialmente maliciosa según la lógica del sistema o la inteligencia externa.

vulnerable

bool

Indica si se sabe que la entidad tiene vulnerabilidades de seguridad existentes.

attacker

bool

Se marca si la entidad se identifica como la fuente de actividad maliciosa.

internal

bool

Indica si la entidad pertenece a la infraestructura o la red interna de la organización.

fields

list[MutableMapping[str, Any]]

Es una lista de propiedades adicionales o puntos de datos enriquecidos asociados con la entidad.

class TIPCommon.data_models.EntityCard

clase TIPCommon.data_models.EntityCard(identifier, entity_type, is_suspicious, linked_entities)

Bases: object

EntityCard representa una vista resumida de una entidad, que se suele usar para los componentes de IU. Agrega la identificación, el tipo y las relaciones de la entidad con otras entidades en una estructura simplificada.

Métodos

Los siguientes métodos administran la serialización y la reconstrucción de las tarjetas de entidades.

Métodos
from_json()

from_json(entity_data: MutableMapping[str, Any]) → EntityCard

Es un método de clase que inicializa una instancia de EntityCard a partir de un diccionario de datos de resumen de la entidad.

to_json()

to_json() → MutableMapping[str, Any]

Convierte el objeto EntityCard en un formato de diccionario serializable en JSON.

Atributos

En la siguiente tabla, se destacan las propiedades principales que se usan para identificar y vincular entidades dentro de la tarjeta.

Atributos
identifier

str

Es el valor o nombre único que identifica la entidad.

entity_type

str

Es la categoría de clasificación de la entidad.

is_suspicious

str

Un indicador de cadena (a menudo, True o False) que representa el estado sospechoso de la entidad.

linked_entities

list[str]

Es una lista de identificadores de otras entidades relacionadas con esta tarjeta de entidad específica.

class TIPCommon.data_models.EnvironmentData

clase TIPCommon.data_models.EnvironmentData(environment, dynamic_parameters=<factory>, base64_image=None, platform=None)

Bases: object

EnvironmentData encapsula la información de configuración y desarrollo de la marca para un entorno organizacional específico. Esto incluye parámetros específicos del entorno y recursos visuales que se usan para implementaciones de varios usuarios o entornos.

Métodos

El siguiente método facilita la creación de objetos de datos del entorno a partir de datos JSON estructurados.

Métodos
from_json()

from_json(json_data: MutableMapping[str, Any]) → EnvironmentData

Es un método de clase que inicializa una instancia de EnvironmentData a partir de un diccionario de propiedades ambientales.

Atributos

En la siguiente tabla, se destacan los parámetros de configuración y los recursos de desarrollo de la marca asociados con el entorno.

Atributos
environment

str

Es el nombre del entorno de la organización.

dynamic_parameters

list[DynamicParameter]

Es una lista de pares clave-valor personalizados específicos de la configuración de este entorno.

base64_image

str | None

Es una cadena opcional codificada en base64 que representa el ícono o el logotipo del entorno.

platform

int | None

Es un identificador entero que representa la plataforma específica o el proveedor de infraestructura.

class TIPCommon.data_models.EventCard

clase TIPCommon.data_models.EventCard(case_id, alert_identifier, event_id, name, time, product, port, outcome, artifact_entities, fields)

Bases: object

EventCard representa un resumen conciso y visualmente atractivo de un evento de seguridad específico. Está diseñado para mostrar la telemetría más importante, como la sincronización, el producto fuente y el resultado, para su uso en paneles de investigación y colas de eventos.

Métodos

Los siguientes métodos administran la conversión de datos de tarjetas de eventos entre instancias de objetos y formatos JSON.

Métodos
from_json()

from_json(event_data: MutableMapping[str, Any]) → EventCard

Es un método de clase que inicializa una instancia de EventCard a partir de un diccionario de atributos de eventos.

to_json()

to_json() → MutableMapping[str, Any]

Convierte el objeto EventCard en un formato de diccionario serializable en JSON.

Atributos

En la siguiente tabla, se destacan los identificadores principales de telemetría y de organización que se almacenan en la tarjeta de evento.

Atributos
event_id

str

Es el identificador único del registro de evento específico.

time

int

Es la marca de tiempo de Unix que representa cuándo ocurrió el evento.

product

str

Es el producto o la herramienta de seguridad que generó la telemetría del evento.

outcome

str

Es el resultado registrado del evento.

artifact_entities

list[MutableMapping[str, Any]]

Es una lista de entidades identificadas en la telemetría del evento que sirven como artefactos para el caso.

fields

list[MutableMapping[str, Any]]

Es una colección de propiedades clave-valor adicionales específicas de la carga útil de datos de este evento.

class TIPCommon.data_models.EventPropertyField

clase TIPCommon.data_models.EventPropertyField(order, group_name, is_integration, is_highlight, items)

Bases: object

EventPropertyField define una colección estructurada de atributos de eventos, organizada por prioridad y agrupación. Se usa para categorizar los datos de telemetría para su visualización, destacando los campos críticos para el enfoque de la investigación.

Métodos

El siguiente método controla la reconstrucción de objetos de campos de propiedad a partir de datos JSON estructurados.

Métodos
from_json()

from_json(event_property_field: MutableMapping[str, Any]) → EventPropertyField

Es un método de clase que inicializa una instancia de EventPropertyField a partir de un diccionario de atributos de campo.

Atributos

En la siguiente tabla, se destacan los metadatos y los elementos de contenido que definen el campo de propiedad del evento.

Atributos
group_name

str

Nombre del grupo lógico al que pertenecen estos campos.

is_highlight

bool

Indica si este campo debe destacarse visualmente en la IU de la plataforma como un punto de datos de alta prioridad.

items

list[FieldItem]

Es una lista de elementos de datos específicos incluidos en este grupo de propiedades.

class TIPCommon.data_models.FieldGroupItem

clase TIPCommon.data_models.FieldGroupItem(original_name, name, value)

Bases: object

FieldGroupItem representa un punto de datos específico dentro de un grupo de campos, y mantiene una asignación entre el nombre de la fuente original y el nombre visible legible para el usuario.

Métodos

Los siguientes métodos administran la serialización y la reconstrucción de los elementos del grupo de campos.

Métodos
from_json()

from_json(field_group_json: MutableMapping[str, Any]) → FieldGroupItem

Es un método de clase que inicializa una instancia de FieldGroupItem a partir de un diccionario JSON.

to_json()

to_json() → MutableMapping[str, Any]

Convierte el objeto FieldGroupItem en un formato de diccionario serializable en JSON.

class TIPCommon.data_models.FieldItem

clase TIPCommon.data_models.FieldItem(original_name, name, value)

Bases: object

FieldItem es una estructura de datos base para propiedades individuales que almacena la clave sin procesar, la etiqueta asignada y el valor asociado.

Métodos

Métodos
from_json()

from_json(field_json: MutableMapping[str, Any]) → FieldItem

Es un método de clase que crea una instancia de FieldItem a partir de un diccionario de propiedades de campo.

class TIPCommon.data_models.FieldsGroup

clase TIPCommon.data_models.FieldsGroup(order, group_name, is_integration, is_highlight, hide_options, items)

Bases: object

FieldsGroup sirve como contenedor para organizar varios elementos de campo en una colección lógica. Se usa principalmente para controlar el diseño y la visibilidad de los datos dentro de la interfaz de usuario de la plataforma.

Métodos

Los siguientes métodos administran la conversión de datos de grupos de campos entre instancias de objetos y JSON estructurado.

Métodos
from_json()

from_json(field_group_json: MutableMapping[str, Any]) → FieldsGroup

Es un método de clase que inicializa una instancia de FieldsGroup a partir de un diccionario de atributos de grupo.

to_json()

to_json() → MutableMapping[str, Any]

Convierte el objeto FieldsGroup en un formato de diccionario serializable en JSON.

Atributos

En la siguiente tabla, se destacan las propiedades que definen el comportamiento de visualización y el contenido del grupo.

Atributos
group_name

str

Es la etiqueta que se usa para identificar el grupo en la IU.

is_highlight

bool

Determina si el grupo debe destacarse visualmente.

items

list[FieldGroupItem]

Es una lista de puntos de datos específicos incluidos en el grupo.

class TIPCommon.data_models.GoogleServiceAccount

clase TIPCommon.data_models.GoogleServiceAccount(account_type, project_id, private_key_id, private_key, client_email, client_id, auth_uri, token_uri, auth_provider_x509_url, client_x509_cert_url)

Bases: object

GoogleServiceAccount proporciona una representación estructurada de las credenciales de la cuenta de servicio. Google CloudSe usa para administrar los detalles de autenticación de las integraciones que interactúan con los servicios de Google.

Métodos

El siguiente método facilita la exportación de datos de credenciales al formato estándar que requieren las bibliotecas cliente.

Métodos
to_dict()

to_dict() → dict[str, str]

Serializa las propiedades de la cuenta de servicio en un diccionario compatible con el formato estándar service-account-file.json.

class TIPCommon.data_models.Insight

clase TIPCommon.data_models.Insight(raw_data)

Bases: object

Insight representa un hallazgo o una observación analíticos discretos generados por la plataforma o una integración. Encapsula datos sin procesar que proporcionan contexto adicional o acciones recomendadas para una investigación de seguridad.

Métodos

Los siguientes métodos administran la serialización y la reconstrucción de objetos de estadísticas.

Métodos
from_json()

from_json(insights_response: MutableMapping[str, Any]) → Insight

Es un método de clase que crea una instancia de Insight a partir de un diccionario de datos de telemetría de estadísticas sin procesar.

to_json()

to_json() → MutableMapping[str, Any]

Serializa el objeto Insight en un formato de diccionario compatible con JSON.

Atributos

Atributos
raw_data

MutableMapping[str, Any]

Es la carga útil de datos sin procesar subyacente que contiene los hallazgos y las métricas específicos de la estadística.

class TIPCommon.data_models.InstalledIntegrationInstance

clase TIPCommon.data_models.InstalledIntegrationInstance(instance, identifier, integration_identifier, environment_identifier, instance_name)

Bases: object

InstalledIntegrationInstance representa una instancia específica y configurada de una integración que se implementó en un entorno. Vincula la definición de integración general a su implementación y nomenclatura específicas del entorno.

Métodos

Los siguientes métodos administran la conversión de datos de instancias de integración entre instancias de objetos y JSON estructurado.

Métodos
from_json()

from_json(integration_env_json: MutableMapping[str, Any]) → InstalledIntegrationInstance

Es un método de clase que analiza datos JSON en un objeto InstalledIntegrationInstance.

to_json()

to_json() → MutableMapping[str, Any]

Serializa los datos de la instancia de integración en un formato de diccionario compatible con JSON.

Atributos

En la siguiente tabla, se destacan los identificadores que se usan para hacer un seguimiento de la integración en diferentes entornos organizativos.

Atributos
instance_name

str

Es el nombre definido por el usuario para esta instancia de integración específica.

integration_identifier

str

Es el identificador único de la integración principal.

environment_identifier

str

Es el identificador del entorno de la organización en el que se instaló esta instancia.

class TIPCommon.data_models.InternalDomain

clase TIPCommon.data_models.InternalDomain(alias_name, id_, domain_display_name, environments_json, creation_time_unix_time_in_ms, modification_time_unix_time_in_ms)

Bases: object

InternalDomain representa un identificador de dominio que se reconoce como parte de la infraestructura interna de la organización. Estos registros son fundamentales para distinguir entre el tráfico interno y las amenazas externas durante las investigaciones de seguridad.

Métodos

Los siguientes métodos administran la serialización y la reconstrucción de los registros internos del dominio.

Métodos
from_json()

from_json(json_data: MutableMapping[str, Any]) → InternalDomain

Es un método de clase que crea un objeto InternalDomain a partir de un diccionario JSON.

to_json()

to_json() → MutableMapping[str, Any]

Convierte el objeto InternalDomain en un formato de diccionario serializable en JSON.

Atributos

En la siguiente tabla, se destacan las propiedades que se usan para identificar y categorizar los dominios internos.

Atributos
domain_display_name

str

Es el nombre de dominio principal.

alias_name

str

Es un nombre o una etiqueta alternativos que se usan para identificar el dominio dentro de la plataforma.

environments_json

str

Es una cadena con formato JSON que enumera los entornos en los que este dominio se considera interno.

class TIPCommon.data_models.JobParamType

clase TIPCommon.data_models.JobParamType(value)

Bases: Enum

JobParamType define los tipos de datos admitidos para los parámetros que se usan en los trabajos programados o las tareas de automatización. Estos tipos facilitan la validación de entrada adecuada y el manejo a nivel de la plataforma.

Constantes

Las siguientes constantes representan los tipos de datos específicos disponibles para los parámetros de trabajo.

Constantes
BOOLEAN 0
INTEGER 1
STRING 2
PASSWORD 3
IP 4
HOST 5
URL 6
DOMAIN 7
EMAIL 8
NULL -1

class TIPCommon.data_models.Parameter

clase TIPCommon.data_models.Parameter(raw_param)

Bases: object

Parameter sirve como la clase base principal para todos los modelos relacionados con parámetros en la biblioteca. Proporciona una interfaz coherente para controlar los datos de configuración sin procesar.

Atributos

La siguiente propiedad proporciona acceso a los datos subyacentes que se usan para inicializar el parámetro.

Atributos
raw_data

dict[str, Any]

Es la carga útil del diccionario original que contiene la configuración del parámetro.

Ejemplo

En el siguiente ejemplo, se muestra cómo inicializar la clase base Parameter y acceder a sus datos sin procesar.

>>> from data_models import Parameter
>>> p = Parameter({'foo': 'bar'})
>>> print(p)
Parameter(raw_data={'foo': 'bar'})

class TIPCommon.data_models.SLA

clase TIPCommon.data_models.SLA(sla_expiration_time, critical_expiration_time, expiration_status, remaining_time_since_last_pause)

Bases: object

El ANS (Acuerdo de Nivel de Servicio) encapsula las restricciones de tiempo y el estado de una alerta. Proporciona un seguimiento de alta precisión para los plazos estándar y críticos, incluida la lógica para las pausas controladas.

Métodos

Los siguientes métodos administran la conversión de datos del ANS entre instancias de objetos y JSON estructurado.

Métodos
from_json()

from_json(sla_json: MutableMapping[str, Any]) → SLA

Es un método de clase que inicializa una instancia de SLA a partir de un diccionario JSON.

to_json()

to_json() → MutableMapping[str, Any]

Convierte el objeto SLA en un formato de diccionario serializable en JSON.

Atributos

En la siguiente tabla, se destacan los atributos de tiempo principales que se usan para hacer un seguimiento del vencimiento de las alertas.

Atributos
sla_expiration_time

int | None

Es la marca de tiempo de Unix que representa la fecha límite de vencimiento del ANS estándar.

critical_expiration_time

int | None

Es la marca de tiempo de Unix que representa la fecha límite de vencimiento del ANS crítico.

expiration_status

int

Es el estado actual del ANS.

class TIPCommon.data_models.ScriptContext

clase TIPCommon.data_models.ScriptContext(target_entities: 'str' = '', case_id: 'int | str | None' = None, alert_id: 'str' = '', environment: 'str' = '', workflow_id: 'str' = '', workflow_instance_id: 'str | None' = None, parameters: 'SingleJson' = <factory>, integration_identifier: 'str' = '', integration_instance: 'str' = '', action_definition_name: 'str' = '', original_requesting_user: 'str' = '', execution_deadline_unix_time_ms: 'int' = 0, async_polling_interval_in_sec: 'int' = 0, async_total_duration_deadline: 'int' = 0, script_timeout_deadline: 'int' = 0, default_result_value: 'str' = '', use_proxy_settings: 'bool' = False, max_json_result_size: 'int' = 15, vault_settings: 'SiemplifyVault | None' = None, environment_api_key: 'str | None' = None, unique_identifier: 'str' = '', job_api_key: 'str' = '', connector_context: 'ConnectorContext | None' = None)

Bases: object

ScriptContext es un contenedor integral que proporciona el entorno, los identificadores y los parámetros necesarios para la ejecución de la secuencia de comandos. Realiza un seguimiento de todo, desde las entidades objetivo y los IDs de flujo de trabajo hasta la configuración de seguridad, como las configuraciones de proxy y de bóveda.

Métodos

Los siguientes métodos permiten modificar y serializar el contexto de ejecución de la secuencia de comandos.

Métodos
to_json()

to_json() → MutableMapping[str, Any]

Serializa el ScriptContext en un formato de diccionario compatible con JSON.

update()

update(attributes: MutableMapping[str, Any]) → None

Actualiza los atributos de contexto con los valores de un diccionario proporcionado.

Atributos

Dado el carácter extenso del contexto, en la siguiente tabla, se destacan los identificadores de ejecución y de entorno más importantes.

Atributos
case_id

int | str | None

Es el identificador del caso asociado con la ejecución del script actual.

workflow_id

str

Es el ID del flujo de trabajo que se está procesando actualmente.

parameters

SingleJson

Es un diccionario que contiene los parámetros de tiempo de ejecución que se pasaron a la secuencia de comandos.

execution_deadline_unix_time_ms

int

Es la marca de tiempo de Unix que indica cuándo debe finalizar la ejecución de la secuencia de comandos.

vault_settings

SiemplifyVault | None

Parámetros de configuración para acceder a los datos sensibles almacenados en la bóveda de la plataforma.

class TIPCommon.data_models.SmimeEmailConfig

clase TIPCommon.data_models.SmimeEmailConfig(email, private_key_b64, certificate_b64, ca_certificate_b64)

Bases: object

SmimeEmailConfig encapsula los activos criptográficos necesarios y el mensaje de correo electrónico requerido para realizar operaciones de S/MIME, como la firma o la encriptación. Contiene el correo electrónico sin procesar y las claves y los certificados codificados en base64.

Atributos

En la siguiente tabla, se describen los componentes criptográficos que administra este modelo de configuración.

Atributos
email

email.message.Message

Es el objeto de mensaje de correo electrónico estándar de Python que se procesará.

private_key_b64

str

Es la clave privada codificada en Base64 que se usa para la firma o la desencriptación.

certificate_b64

str

Certificado público codificado en Base64 asociado a la clave privada.

ca_certificate_b64

str

Certificado de la autoridad certificadora (CA) codificado en Base64 que se usa para verificar la cadena de confianza.

class TIPCommon.data_models.SmimeType

clase TIPCommon.data_models.SmimeType(value)

Bases: Enum

SmimeType define el modo operativo para el procesamiento de S/MIME, y distingue entre la protección del contenido a través de la encriptación o la validación del remitente con una firma digital.

Constantes

Las siguientes constantes representan los tipos de mensajes S/MIME admitidos.

Constantes
SIGNED 'signed' (El mensaje está firmado digitalmente para garantizar su autenticidad).
ENCRYPTED 'encrypted' (el cuerpo del mensaje está encriptado para garantizar la confidencialidad)

class TIPCommon.data_models.TypedContainer

clase TIPCommon.data_models.TypedContainer()

Bases: Generic[T]

TypedContainer es un wrapper genérico diseñado para contener datos de un tipo específico. Mejora la productividad de los desarrolladores, ya que proporciona sugerencias de tipos y funciones de IntelliSense, lo que garantiza que los IDE y las herramientas de análisis estático traten el objeto almacenado de forma correcta.

class TIPCommon.data_models.UserDetails

clase TIPCommon.data_models.UserDetails(id_: int, creation_time_unix_time_in_ms: int, modification_time_unix_time_in_ms: int, permission_group: str, permission_groups: list[str], soc_roles: list[str], is_disabled: bool, login_identifier: str, first_name: str, last_name: str, permission_type: int, role: int, soc_role_id: int, soc_role_ids: list[int], email: str, user_name: str, user_type: int, identity_provider: int, provider_name: str, advanced_reports_access: int, account_state: int, last_login_time: int, previous_login_time: int, last_password_change_time: int, last_password_change_notification_time: int, login_wrong_password_count: int, is_deleted: bool, deletion_time_unix_time_in_ms: int, environments: list[str], allowed_platforms: list[int], data_access_context: [DataAccessContext](#TIPCommon.data_models.DataAccessContext), soc_role: str | None, image_base64: str | None)

Bases: object

UserDetails proporciona un perfil exhaustivo de un usuario de la plataforma, que abarca metadatos de autenticación, roles organizacionales y permisos de acceso a datos detallados. Es fundamental para administrar las sesiones de usuario y aplicar el control de acceso basado en roles (RBAC).

Métodos

Los siguientes métodos facilitan la reconstrucción y la serialización de los datos del perfil del usuario.

Métodos
from_json()

from_json(user_details_json: MutableMapping[str, Any]) → UserDetails

Es un método de clase que inicializa una instancia de UserDetails a partir de un diccionario JSON de atributos del usuario.

to_json()

to_json() → MutableMapping[str, Any]

Convierte el objeto UserDetails en un formato de diccionario serializable en JSON.

Atributos

En la siguiente tabla, se destacan las estructuras principales de identificación y permisos para el usuario.

Atributos
user_name

str

Es el nombre de usuario único del sistema que se usa para acceder y realizar la identificación.

soc_roles

list[str]

Es una lista de los roles de SOC asignados al usuario, que definen sus permisos operativos.

data_access_context

DataAccessContext

Es el contexto que define a qué permisos de datos y unidades organizativas puede acceder el usuario.

is_disabled

bool

Es una marca booleana que indica si la cuenta del usuario tiene restricciones para acceder.

class TIPCommon.data_models.UserProfileCard

clase TIPCommon.data_models.UserProfileCard(raw_data, first_name, last_name, user_name, account_state)

Bases: object

UserProfileCard proporciona un resumen ligero del perfil de un usuario, diseñado para mostrarse en componentes de la IU, como encabezados o tarjetas de contacto, en los que no se requieren los detalles completos.

Métodos

Métodos
from_json()

from_json(user_profile_card_response: dict) → UserProfileCard

Es un método de clase que crea una instancia de UserProfileCard a partir de un diccionario de atributos de perfil básicos.

class TIPCommon.data_models.WallData

clase TIPCommon.data_models.WallData(raw_data, case_id, activity_kind, activity_data_json, favorite)

Bases: object

WallData representa una entrada en el "muro" o la línea de tiempo de un caso. Este modelo hace un seguimiento de los registros de actividad, las notas y las acciones del sistema que se producen durante el ciclo de vida de una investigación.

Métodos

Métodos
from_json()

from_json(data: MutableMapping[str, Any]) → WallData

Es un método de clase que inicializa una instancia de WallData a partir de un diccionario JSON de actividad del muro.

to_json()

to_json() → MutableMapping[str, Any]

Serializa el objeto WallData en un formato de diccionario compatible con JSON.

Atributos

Atributos
activity_kind

str | int | None

Es la categoría de la actividad.

activity_data_json

str | None

Es una cadena con formato JSON que contiene los detalles o la carga útil específicos de la actividad.

favorite

bool

Indica si la entrada de actividad se fijó o marcó como favorita para consultarla rápidamente.

¿Necesitas más ayuda? Obtén respuestas de miembros de la comunidad y profesionales de Google SecOps.