Módulo data_models
Esse módulo contém classes de dados para representar o seguinte:
- Modelos de dados
- Alertas
- Contêineres de variáveis
- Parameters gerais
- Parâmetros do conector
class TIPCommon.data_models.AlertCard
class 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
O AlertCard representa um card de resumo para um alerta, encapsulando metadados e indicadores de status essenciais usados para visualização e rastreamento na plataforma.
Métodos
Os métodos a seguir facilitam a serialização e a reconstrução de cards de alerta com base em dados estruturados.
| Métodos | |
|---|---|
from_json() |
Um método de classe que cria uma instância |
to_json() |
Converte o objeto |
Atributos
A tabela a seguir destaca os principais atributos estruturais e modelos de dados complexos associados ao alerta.
| Atributos | |
|---|---|
fields_groups |
Uma lista de campos agrupados associados ao alerta, usada para apresentação de dados estruturados na UI. |
sla |
O objeto do contrato de nível de serviço que define os prazos de resposta e resolução do alerta. |
class TIPCommon.data_models.AlertEvent
class 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
O AlertEvent representa um evento individual associado a um alerta, contendo dados de telemetria específicos, propriedades de campo e relacionamentos de entidades.
Métodos
O método a seguir fƒconacilitates a reconstrução de objetos de evento de dados JSON estruturados.
| Métodos | |
|---|---|
from_json() |
Um método de classe que cria uma instância |
Atributos
A tabela a seguir destaca os principais atributos estruturais e modelos de dados complexos associados ao evento.
| Atributos | |
|---|---|
fields |
Uma lista de campos de propriedade específicos do evento, definindo seus pontos de dados exclusivos. |
artifact_entities |
Uma lista de identificadores de entidade extraídos da telemetria de eventos. |
class TIPCommon.data_models.AlertPriority
class TIPCommon.data_models.AlertPriority(value)
Bases: Enum
AlertPriority define os níveis de gravidade padronizados com base em números inteiros usados para categorizar e priorizar alertas na plataforma.
Constantes
As constantes a seguir representam os valores de prioridade específicos atribuídos aos alertas.
| Constantes | |
|---|---|
CRITICAL |
100 |
HIGH |
80 |
MEDIUM |
60 |
LOW |
40 |
UNCHANGED |
0 |
INFORMATIVE |
-1 |
class TIPCommon.data_models.AttachmentMetadata
class TIPCommon.data_models.AttachmentMetadata(raw_data: SingleJson)
Bases: object
AttachmentMetadata encapsula os dados descritivos e as propriedades associadas a um anexo de arquivo, fornecendo métodos para conversão e recuperação de dados estruturados.
Métodos
O método a seguir oferece uma maneira padronizada de reconstruir objetos de caso de payloads JSON.
| Métodos | |
|---|---|
from_json() |
Um método de classe que inicializa uma nova instância |
to_json() |
Serializa o objeto |
Atributos
A tabela a seguir destaca as principais estruturas de dados usadas para armazenar as propriedades de metadados do anexo.
| Atributos | |
|---|---|
raw_data |
O dicionário subjacente que contém os atributos de metadados brutos conforme recebidos da origem. |
class TIPCommon.data_models.BaseAlert
class TIPCommon.data_models.BaseAlert(raw_data, alert_id)
Bases: object
BaseAlert é um modelo fundamental que representa um alerta de segurança genérico. Ele fornece uma estrutura padronizada para armazenar telemetria bruta junto com um identificador de plataforma exclusivo.
Métodos
O método a seguir permite a serialização do alerta em um formato padrão.
| Métodos | |
|---|---|
to_json() |
Converte o alerta em um dicionário serializável em JSON, conforme retornado por
|
Atributos
A tabela a seguir destaca os principais pontos de dados gerenciados por esse modelo.
| Atributos | |
|---|---|
raw_data |
O payload de dados brutos associado ao alerta. |
alert_id |
O identificador exclusivo atribuído ao alerta. |
Exemplo
O exemplo a seguir demonstra como inicializar um BaseAlert
e acessar os dados brutos e a saída serializada dele.
>>> 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
class TIPCommon.data_models.BaseDataModel(raw_data)
Bases: object
O BaseDataModel atua como a classe mãe para várias estruturas de dados na biblioteca, garantindo o processamento consistente de dados de entrada brutos e serialização.
Métodos
O método a seguir garante que os dados brutos sejam recuperados em um formato compatível com operações JSON.
| Métodos | |
|---|---|
to_json() |
Serializa os dados brutos armazenados no modelo em um formato de dicionário. |
Atributos
A tabela a seguir descreve o armazenamento de dados principal do modelo de base.
| Atributos | |
|---|---|
raw_data |
O payload de dados brutos original usado para inicializar o modelo. |
Exemplo
O exemplo a seguir mostra a inicialização básica do modelo de dados e o uso do método de serialização.
>>> from data_models import BaseDataModel
>>> data = BaseDataModel({'foo': 'bar'})
>>> data.raw_data
{'foo': 'bar'}
>>> data.to_json()
{'foo': 'bar'}
class TIPCommon.data_models.CaseDataStatus
class TIPCommon.data_models.CaseDataStatus(value)
Bases: Enum
CaseDataStatus define os status operacionais compatíveis para casos na plataforma, desde a ingestão inicial até o encerramento ou a fusão final.
Constantes
As constantes a seguir representam os indicadores de status específicos atribuídos aos dados de caso.
| Constantes | |
|---|---|
NEW |
0 |
OPENED |
1 |
CLOSED |
2 |
ALL |
3 |
MERGED |
4 |
CREATION_PENDING |
5 |
class TIPCommon.data_models.CaseDetails
Bases: object
O CaseDetails oferece uma visão abrangente de um caso de segurança, incluindo propriedades de verificação de estado e métodos para reconstruir ou serializar dados de caso.
Métodos
Os métodos a seguir gerenciam a conversão de detalhes de casos entre instâncias de objetos e formatos JSON estruturados.
| Métodos | |
|---|---|
from_json() |
Um método de classe que inicializa uma instância |
to_json() |
Converte o objeto |
Atributos
As propriedades a seguir fornecem indicadores lógicos sobre o estado atual do caso.
| Atributos | |
|---|---|
is_closed |
Uma propriedade booleana que indica se o caso está fechado. |
is_open |
Uma propriedade booleana que indica se o caso está ativo ou aberto. |
class TIPCommon.data_models.CaseOverviewInfo
class 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
O CaseOverviewInfo fornece um resumo de alto nível de um caso de segurança, agregando metadados, status do contrato de nível de serviço (SLA) e detalhes organizacionais usados para painéis e gerenciamento de filas.
Métodos
O método a seguir facilita a reconstrução de objetos de visão geral de caso de dados JSON estruturados.
| Métodos | |
|---|---|
from_json() |
Um método de classe que inicializa uma instância |
Atributos
A tabela a seguir destaca os principais atributos estruturais, enums e métricas operacionais importantes associados à visão geral do caso.
| Atributos | |
|---|---|
priority |
O nível de gravidade atribuído ao caso. |
status |
O status operacional atual dos dados do caso. |
workflow_status |
A etapa ou o estado atual no mecanismo de fluxo de trabalho automatizado da plataforma. |
score |
O risco calculado ou a pontuação de importância atribuída ao caso. |
case_sla |
Informações de rastreamento de SLA especificamente para o ciclo de vida da resolução de casos. |
alerts_sla |
Informações de rastreamento do SLA para os alertas individuais contidos no caso. |
environment_data |
Metadados sobre o ambiente organizacional específico em que o caso foi originado. |
tags |
Uma lista de rótulos definidos pelo usuário ou gerados pelo sistema associados ao caso. |
class TIPCommon.data_models.CasePriority
class TIPCommon.data_models.CasePriority(value)
Bases: Enum
CasePriority define os níveis de gravidade padronizados com base em números inteiros usados para categorizar e priorizar casos na plataforma.
Constantes
As constantes a seguir representam os valores de prioridade específicos atribuídos aos casos.
| Constantes | |
|---|---|
CRITICAL |
100 |
HIGH |
80 |
MEDIUM |
60 |
LOW |
40 |
UNCHANGED |
0 |
INFORMATIVE |
-1 |
class TIPCommon.data_models.CaseSLAInfo
class 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
O CaseSLAInfo encapsula dados de rastreamento do contrato de nível de serviço (SLA), fornecendo carimbos de data/hora para indicadores de expiração e status para garantir uma resposta rápida a incidentes.
Métodos
O método a seguir permite a criação de objetos de informações de SLA com dados JSON estruturados.
| Métodos | |
|---|---|
from_json() |
Um método de classe que inicializa uma instância |
Atributos
A tabela a seguir destaca os principais atributos de tempo e status usados para monitorar os prazos dos casos.
| Atributos | |
|---|---|
expiration_time_ms |
O carimbo de data/hora do Unix (em milissegundos) em que o SLA padrão está definido para expirar. |
critical_expiration_time_ms |
O carimbo de data/hora Unix (em milissegundos) em que o limite crítico do SLA é atingido. |
expiration_status |
Um indicador inteiro que representa o status atual do SLA. |
last_pause_remaining_time_ms |
A quantidade de tempo restante no relógio do SLA no momento em que ele foi pausado pela última vez. |
class TIPCommon.data_models.CaseWallAttachment
class TIPCommon.data_models.CaseWallAttachment(name, file_type, base64_blob, is_important, case_id=None, description=None)
Bases: object
CaseWallAttachment representa um arquivo ou objeto de dados anexado ao mural de evidências de um caso, incluindo o conteúdo bruto em formato base64 e os metadados associados.
Atributos
A tabela a seguir destaca as principais propriedades e os dados de conteúdo associados ao anexo.
| Atributos | |
|---|---|
name |
O nome do arquivo ou de exibição do anexo. |
file_type |
O tipo MIME ou a extensão do arquivo que indica o formato dos dados anexados. |
base64_blob |
O conteúdo real do arquivo, codificado como uma string base64. |
is_important |
Uma flag que indica se o anexo está marcado como evidência crítica para a investigação. |
class TIPCommon.data_models.ConnectorCard
class TIPCommon.data_models.ConnectorCard(integration, display_name, identifier, is_enabled, is_remote, status)
Bases: object
O ConnectorCard fornece um resumo da configuração de um conector específico e
estado operacional atual na plataforma.
Métodos
O método a seguir facilita a criação de instâncias de card de conector com dados JSON estruturados.
| Métodos | |
|---|---|
from_json() |
Um método de classe que inicializa uma instância |
Atributos
A tabela a seguir destaca o status operacional e as propriedades de identificação do conector.
| Atributos | |
|---|---|
status |
O status atual de conectividade e integridade do conector. |
is_enabled |
Indica se o conector está ativo e processando dados. |
class TIPCommon.data_models.ConnectorConnectivityStatusEnum
class TIPCommon.data_models.ConnectorConnectivityStatusEnum(value)
Bases: Enum
O ConnectorConnectivityStatusEnum define os possíveis estados de conectividade de um conector, indicando se ele está se comunicando com a integração de destino de maneira adequada.
Constantes
As constantes a seguir representam o status de integridade da conexão do conector.
| Constantes | |
|---|---|
LIVE |
0 |
NO_CONNECTIVITY |
1 |
class TIPCommon.data_models.ConnectorParamTypes
class TIPCommon.data_models.ConnectorParamTypes(value)
Bases: Enum
ConnectorParamTypes define os tipos de dados compatíveis com parâmetros de configuração do conector. Esses tipos garantem a validação e a renderização adequadas da UI nas configurações da plataforma.
Constantes
As constantes a seguir representam os tipos de dados específicos disponíveis para parâmetros.
| Constantes | |
|---|---|
BOOLEAN |
0 (alternância booleana) |
INTEGER |
1 (número inteiro) |
STRING |
2 (string de texto padrão) |
PASSWORD |
3 (campo de senha mascarada) |
IP |
4 (endereço IP) |
HOST |
5 (nome do host) |
URL |
6 (string de URL) |
DOMAIN |
7 (nome de domínio) |
EMAIL |
8 (endereço de e-mail) |
SCRIPT |
12 (parâmetro de script legado) |
NULL |
-1 (tipo de parâmetro inválido) |
class TIPCommon.data_models.ConnectorParameter
class TIPCommon.data_models.ConnectorParameter(raw_param)
Bases: Parameter
ConnectorParameter representa uma configuração individual de um conector. Ele estende o modelo de parâmetro base para incluir metadados específicos, como tipos de validação e requisitos obrigatórios.
Atributos
As propriedades a seguir fornecem acesso aos detalhes de configuração e às restrições do parâmetro do conector.
| Atributos | |
|---|---|
name |
O nome exclusivo usado para identificar o parâmetro na configuração do conector. |
value |
O valor atual atribuído ao parâmetro. |
type |
O tipo de dados do parâmetro, usado para validação e renderização da UI. |
mode |
O modo operacional ou a configuração de visibilidade do parâmetro. |
is_mandatory |
Indica se um valor precisa ser fornecido para esse parâmetro antes que o conector seja salvo ou executado. |
Exemplo
O exemplo a seguir demonstra como inicializar um ConnectorParameter
usando um dicionário bruto e acessar as propriedades dele.
>>> 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
class TIPCommon.data_models.Container()
Bases: object
O Container atua como um objeto genérico e dinâmico para armazenar variáveis como atributos. É útil para transmitir coleções de dados arbitrárias entre diferentes componentes da plataforma.
Exemplo
O exemplo a seguir mostra como inicializar um contêiner e atribuir e recuperar uma variável de forma dinâmica.
>>> from data_models import Container
>>> container = Container()
>>> container.one = 1
>>> container.one
1
class TIPCommon.data_models.CreateEntity
class 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
O CreateEntity encapsula as instruções necessárias para criar e vincular uma nova entidade a um caso e alerta atuais. Ele inclui lógica para mapeamento de conexões e relacionamentos com base em regex.
Métodos
O método a seguir processa a conversão de instruções de criação de entidades em um formato compatível com a plataforma.
| Métodos | |
|---|---|
to_json() |
Converte o objeto |
Atributos
A tabela a seguir destaca as principais propriedades usadas para definir a nova entidade e os relacionamentos dela na plataforma.
| Atributos | |
|---|---|
case_id |
O identificador exclusivo do caso em que a entidade será criada. |
alert_identifier |
O identificador do alerta a que esta entidade está associada. |
entity_type |
A classificação da entidade. |
entity_identifier |
O valor ou nome específico que identifica a entidade. |
entity_to_connect_regex |
Uma expressão regular usada para identificar outras entidades que se conectam a esta. |
types_to_connect |
Uma lista específica de tipos de entidades qualificadas para conexão com base na expressão regular. |
is_primary_link |
Indica se essa conexão representa a relação principal entre as entidades. |
is_directional |
Determina se a conexão tem uma direção definida (origem para destino) ou é recíproca. |
class TIPCommon.data_models.CustomField
class TIPCommon.data_models.CustomField(id, display_name, description, type, scopes)
Bases: object
CustomField representa um campo de dados definido pelo usuário na plataforma. Ele permite a extensão de modelos de dados padrão adicionando metadados específicos adaptados aos requisitos organizacionais.
Métodos
O método a seguir permite a reconstrução de objetos de campo personalizado de dados JSON estruturados.
| Métodos | |
|---|---|
from_json() |
Um método de classe que inicializa uma instância |
Atributos
A tabela a seguir destaca as principais propriedades e restrições de escopo do campo personalizado.
| Atributos | |
|---|---|
id |
O identificador exclusivo do campo personalizado. |
display_name |
O rótulo legível mostrado na UI da plataforma. |
type |
O tipo de dados do campo. |
scopes |
Uma lista de áreas de aplicação em que esse campo está disponível |
class TIPCommon.data_models.CustomFieldScope
class TIPCommon.data_models.CustomFieldScope(value)
Bases: Enum
CustomFieldScope define os destinos válidos em que um campo personalizado é aplicado na hierarquia da plataforma.
Métodos
O método a seguir fornece utilidade para resolver o caminho do objeto com escopo.
| Métodos | |
|---|---|
build_parent_path() |
Cria o caminho interno da plataforma para o identificador do objeto pai especificado. |
Constantes
As constantes a seguir representam os escopos específicos disponíveis para campos personalizados.
| Constantes | |
|---|---|
ALERTS |
'Alert' |
CASE |
'Case' |
class TIPCommon.data_models.CustomFieldValue
class TIPCommon.data_models.CustomFieldValue(custom_field_id, values, scope, identifier)
Bases: object
CustomFieldValue representa os dados específicos atribuídos a uma instância de campo personalizado. Ele vincula a definição do campo ao conteúdo real fornecido por um usuário ou processo automatizado.
Métodos
O método a seguir facilita a reconstrução de valores de campos personalizados de dados JSON estruturados.
| Métodos | |
|---|---|
from_json() |
Um método de classe que inicializa uma instância |
Atributos
A tabela a seguir destaca as propriedades principais e os identificadores contextuais do valor do campo personalizado.
| Atributos | |
|---|---|
custom_field_id |
O identificador da definição de |
values |
Uma lista de strings que representam os dados reais armazenados no campo. |
scope |
A área do aplicativo em que esse valor específico é aplicado. |
identifier |
O identificador exclusivo do objeto específico que contém esse valor. |
class TIPCommon.data_models.DataAccessContext
class TIPCommon.data_models.DataAccessContext(global_access, assigned_scopes)
Bases: object
O DataAccessContext define as permissões e restrições de visibilidade para um usuário ou processo, determinando quais escopos de dados são acessíveis durante a execução.
Métodos
Os métodos a seguir gerenciam a conversão de dados de contexto de acesso entre instâncias de objeto e formatos JSON.
| Métodos | |
|---|---|
from_json() |
Um método de classe que inicializa uma instância |
to_json() |
Converte o objeto |
Atributos
A tabela a seguir destaca os principais controles de acesso definidos no contexto.
| Atributos | |
|---|---|
global_access |
Indica se o contexto permite acesso irrestrito a todos os escopos de dados. |
assigned_scopes |
Uma lista de escopos ou unidades organizacionais específicos a que o acesso foi concedido explicitamente. |
class TIPCommon.data_models.DatabaseContextType
class TIPCommon.data_models.DatabaseContextType(value)
Bases: Enum
DatabaseContextType especifica o contexto operacional para interações com o banco de dados, garantindo que os dados sejam mantidos ou recuperados do segmento lógico correto da plataforma.
Constantes
As constantes a seguir representam as áreas específicas da plataforma em que as operações de banco de dados ocorrem.
| Constantes | |
|---|---|
GLOBAL |
0 (contexto global em todo o sistema) |
CASE |
1 (contexto específico do caso de segurança) |
ALERT |
2 (contexto de alerta individual) |
JOB |
3 (job programado ou contexto de automação) |
CONNECTOR |
4 (contexto do conector de dados) |
class TIPCommon.data_models.DynamicParameter
class TIPCommon.data_models.DynamicParameter(key: str, value: str)
Bases: object
DynamicParameter representa um par de chave-valor flexível usado para transmitir configuração de tempo de execução ou metadados personalizados entre componentes do sistema.
Métodos
O método a seguir processa a reconstrução de parâmetros dinâmicos de dados JSON estruturados.
| Métodos | |
|---|---|
from_json() |
Um método de classe que inicializa uma instância |
Atributos
A tabela a seguir descreve as propriedades do parâmetro dinâmico.
| Atributos | |
|---|---|
key |
O nome ou identificador do parâmetro. |
value |
O conteúdo de dados associado à chave. |
class TIPCommon.data_models.EmailTemplate
class 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 um formato de comunicação padronizado usado para notificações e relatórios na plataforma. Ele encapsula o conteúdo da mensagem, os metadados e as restrições ambientais.
Métodos
Os métodos a seguir gerenciam a serialização e a reconstrução de modelos de e-mail.
| Métodos | |
|---|---|
from_json() |
Um método de classe que inicializa uma instância |
to_json() |
Converte o objeto |
Atributos
A tabela a seguir destaca as principais propriedades e os dados estruturais do modelo de e-mail.
| Atributos | |
|---|---|
content |
O texto do corpo ou a estrutura HTML do modelo de e-mail. |
environments |
Uma lista de ambientes organizacionais em que este modelo está disponível para uso. |
template_type |
A classificação ou categoria do modelo. |
class TIPCommon.data_models.Entity
class TIPCommon.data_models.Entity(raw_data, case_id, entity_type, enriched, artifact, vulnerable, suspicious, attacker, pivot, internal, manually_created, fields)
Bases: object
Entidade representa um objeto de interesse ou observável específico em um caso de segurança, como um endereço IP, um hash de arquivo ou um usuário. Ele rastreia a telemetria bruta e várias "tags" booleanas que indicam a função ou o nível de risco da entidade na investigação.
Métodos
Os métodos a seguir gerenciam a serialização e a reconstrução de objetos de entidade.
| Métodos | |
|---|---|
from_json() |
Um método de classe que inicializa uma instância |
to_json() |
Converte o objeto |
Atributos
A tabela a seguir destaca as principais flags de classificação e estruturas de dados associadas à entidade.
| Atributos | |
|---|---|
entity_type |
A categoria da entidade. |
suspicious |
Indica se a entidade foi sinalizada como potencialmente maliciosa pela lógica do sistema ou por inteligência externa. |
vulnerable |
Indica se a entidade tem vulnerabilidades de segurança conhecidas. |
attacker |
Marcado se a entidade for identificada como a origem de atividades maliciosas. |
internal |
Indica se a entidade pertence à rede ou infraestrutura interna da organização. |
fields |
Uma lista de propriedades adicionais ou pontos de dados enriquecidos associados à entidade. |
class TIPCommon.data_models.EntityCard
class TIPCommon.data_models.EntityCard(identifier, entity_type, is_suspicious, linked_entities)
Bases: object
EntityCard representa uma visualização resumida de uma entidade, normalmente usada para componentes UI. Ele agrega a identificação, o tipo e as relações da entidade com outras entidades em uma estrutura simplificada.
Métodos
Os métodos a seguir gerenciam a serialização e a reconstrução de cards de entidade.
| Métodos | |
|---|---|
from_json() |
Um método de classe que inicializa uma instância |
to_json() |
Converte o objeto |
Atributos
A tabela a seguir destaca as principais propriedades usadas para identificar e vincular entidades no card.
| Atributos | |
|---|---|
identifier |
O valor ou nome exclusivo que identifica a entidade. |
entity_type |
A categoria de classificação da entidade. |
is_suspicious |
Um indicador de string (geralmente |
linked_entities |
Uma lista de identificadores de outras entidades relacionadas a este card de entidade específico. |
class TIPCommon.data_models.EnvironmentData
class TIPCommon.data_models.EnvironmentData(environment, dynamic_parameters=<factory>, base64_image=None, platform=None)
Bases: object
EnvironmentData encapsula informações de configuração e branding para um ambiente organizacional específico. Isso inclui parâmetros específicos do ambiente e recursos visuais usados para implantações multilocatárias ou em vários ambientes.
Métodos
O método a seguir facilita a criação de objetos de dados de ambiente com dados JSON estruturados.
| Métodos | |
|---|---|
from_json() |
Um método de classe que inicializa uma instância |
Atributos
A tabela a seguir destaca os parâmetros de configuração e os recursos de marca associados ao ambiente.
| Atributos | |
|---|---|
environment |
O nome do ambiente organizacional. |
dynamic_parameters |
Uma lista de pares de chave-valor personalizados específicos da configuração deste ambiente. |
base64_image |
Uma string opcional codificada em base64 que representa o logotipo ou ícone do ambiente. |
platform |
Um identificador inteiro que representa a plataforma ou o provedor de infraestrutura específico. |
class TIPCommon.data_models.EventCard
class TIPCommon.data_models.EventCard(case_id, alert_identifier, event_id, name, time, product, port, outcome, artifact_entities, fields)
Bases: object
O EventCard representa um resumo conciso e visualmente agradável de um ocorrência de segurança específico. Ele foi projetado para mostrar a telemetria mais crítica, como tempo, produto de origem e resultado, para uso em painéis de investigação e filas de eventos.
Métodos
Os métodos a seguir gerenciam a conversão de dados de card de evento entre instâncias de objeto e formatos JSON.
| Métodos | |
|---|---|
from_json() |
Um método de classe que inicializa uma instância |
to_json() |
Converte o objeto |
Atributos
A tabela a seguir destaca os principais identificadores organizacionais e de telemetria armazenados no card de evento.
| Atributos | |
|---|---|
event_id |
O identificador exclusivo do registro de evento específico. |
time |
O carimbo de data/hora Unix que representa quando o evento ocorreu. |
product |
O produto ou ferramenta de segurança que gerou a telemetria do evento. |
outcome |
O resultado registrado do evento. |
artifact_entities |
Uma lista de entidades identificadas na telemetria de eventos que servem como artefatos para o caso. |
fields |
Uma coleção de outras propriedades de chave-valor específicas do payload de dados deste evento. |
class TIPCommon.data_models.EventPropertyField
class TIPCommon.data_models.EventPropertyField(order, group_name, is_integration, is_highlight, items)
Bases: object
EventPropertyField define uma coleção estruturada de atributos de evento, organizada por prioridade e agrupamento. Ele é usado para categorizar dados de telemetria para exibição, destacando campos críticos para foco investigativo.
Métodos
O método a seguir processa a reconstrução de objetos de campo de propriedade de dados JSON estruturados.
| Métodos | |
|---|---|
from_json() |
Um método de classe que inicializa uma instância |
Atributos
A tabela a seguir destaca os metadados e itens de conteúdo que definem o campo da propriedade do evento.
| Atributos | |
|---|---|
group_name |
O nome do grupo lógico a que esses campos pertencem. |
is_highlight |
Indica se este campo deve ser enfatizado visualmente na UI da plataforma como um ponto de dados de alta prioridade. |
items |
Uma lista de itens de dados específicos contidos neste grupo de propriedades. |
class TIPCommon.data_models.FieldGroupItem
class TIPCommon.data_models.FieldGroupItem(original_name, name, value)
Bases: object
FieldGroupItem representa um ponto de dados específico em um grupo de campos, mantendo um mapeamento entre o nome da fonte original e o nome de exibição legível.
Métodos
Os métodos a seguir gerenciam a serialização e a reconstrução de itens do grupo de campos.
| Métodos | |
|---|---|
from_json() |
Um método de classe que inicializa uma instância |
to_json() |
Converte o objeto |
class TIPCommon.data_models.FieldItem
class TIPCommon.data_models.FieldItem(original_name, name, value)
Bases: object
FieldItem é uma estrutura de dados básica para propriedades individuais, armazenando a chave bruta, o rótulo mapeado e o valor associado.
Métodos
| Métodos | |
|---|---|
from_json() |
Um método de classe que cria uma instância |
class TIPCommon.data_models.FieldsGroup
class TIPCommon.data_models.FieldsGroup(order, group_name, is_integration, is_highlight, hide_options, items)
Bases: object
O FieldsGroup serve como um contêiner para organizar vários itens de campo em uma coleção lógica. Ele é usado principalmente para controlar o layout e a visibilidade dos dados na interface do usuário da plataforma.
Métodos
Os métodos a seguir gerenciam a conversão de dados de grupo de campos entre instâncias de objeto e JSON estruturado.
| Métodos | |
|---|---|
from_json() |
Um método de classe que inicializa uma instância |
to_json() |
Converte o objeto |
Atributos
A tabela a seguir destaca as propriedades que definem o comportamento de exibição e o conteúdo do grupo.
| Atributos | |
|---|---|
group_name |
O rótulo usado para identificar o grupo na UI. |
is_highlight |
Determina se o grupo deve ser enfatizado visualmente. |
items |
Uma lista de pontos de dados específicos contidos no grupo. |
class TIPCommon.data_models.GoogleServiceAccount
class 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 fornece uma representação estruturada de credenciais de conta de serviço Google Cloud. Ele é usado para gerenciar detalhes de autenticação de integrações que interagem com os Serviços do Google.
Métodos
O método a seguir facilita a exportação de dados de credenciais para o formato padrão exigido pelas bibliotecas de cliente.
| Métodos | |
|---|---|
to_dict() |
Serializa as propriedades da conta de serviço em um dicionário
compatível com o formato padrão |
class TIPCommon.data_models.Insight
class TIPCommon.data_models.Insight(raw_data)
Bases: object
Um insight representa uma descoberta ou observação analítica discreta gerada pela plataforma ou por uma integração. Ele encapsula dados brutos que fornecem contexto adicional ou ações recomendadas para uma investigação de segurança.
Métodos
Os métodos a seguir gerenciam a serialização e a reconstrução de objetos de insights.
| Métodos | |
|---|---|
from_json() |
Um método de classe que cria uma instância |
to_json() |
Serializa o objeto |
Atributos
| Atributos | |
|---|---|
raw_data |
O payload de dados brutos subjacente que contém as descobertas e métricas específicas do insight. |
class TIPCommon.data_models.InstalledIntegrationInstance
class TIPCommon.data_models.InstalledIntegrationInstance(instance, identifier, integration_identifier, environment_identifier, instance_name)
Bases: object
InstalledIntegrationInstance representa uma instância específica e configurada de uma integração implantada em um ambiente. Ele vincula a definição geral de integração à implantação e nomenclatura específicas do ambiente.
Métodos
Os métodos a seguir gerenciam a conversão de dados de instâncias de integração entre instâncias de objeto e JSON estruturado.
| Métodos | |
|---|---|
from_json() |
Um método de classe que analisa dados JSON em um objeto
|
to_json() |
Serializa os dados da instância de integração em um formato de dicionário compatível com JSON. |
Atributos
A tabela a seguir destaca os identificadores usados para rastrear a integração em diferentes ambientes organizacionais.
| Atributos | |
|---|---|
instance_name |
O nome definido pelo usuário para essa instância de integração específica. |
integration_identifier |
O identificador exclusivo da integração principal. |
environment_identifier |
O identificador do ambiente organizacional em que esta instância está instalada. |
class TIPCommon.data_models.InternalDomain
class 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 um identificador de domínio reconhecido como parte da infraestrutura interna da organização. Esses registros são essenciais para distinguir entre tráfego interno e ameaças externas durante investigações de segurança.
Métodos
Os métodos a seguir gerenciam a serialização e a reconstrução de registros de domínio internos.
| Métodos | |
|---|---|
from_json() |
Um método de classe que cria um objeto |
to_json() |
Converte o objeto |
Atributos
A tabela a seguir destaca as propriedades usadas para identificar e categorizar domínios internos.
| Atributos | |
|---|---|
domain_display_name |
O nome de domínio principal. |
alias_name |
Um nome ou rótulo alternativo usado para identificar o domínio na plataforma. |
environments_json |
Uma string formatada em JSON que lista os ambientes em que esse domínio é considerado interno. |
class TIPCommon.data_models.JobParamType
class TIPCommon.data_models.JobParamType(value)
Bases: Enum
O JobParamType define os tipos de dados compatíveis para parâmetros usados em jobs programados ou tarefas de automação. Esses tipos facilitam a validação adequada de entradas e o processamento no nível da plataforma.
Constantes
As constantes a seguir representam os tipos de dados específicos disponíveis para parâmetros de job.
| 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
class TIPCommon.data_models.Parameter(raw_param)
Bases: object
Parameter serve como a classe base principal para todos os modelos relacionados a parâmetros na biblioteca. Ela fornece uma interface consistente para processar dados de configuração brutos.
Atributos
A propriedade a seguir fornece acesso aos dados usados para inicializar o parâmetro.
| Atributos | |
|---|---|
raw_data |
O payload do dicionário original que contém a configuração do parâmetro. |
Exemplo
O exemplo a seguir demonstra como inicializar a classe Parameter básica e acessar os dados brutos dela.
>>> from data_models import Parameter
>>> p = Parameter({'foo': 'bar'})
>>> print(p)
Parameter(raw_data={'foo': 'bar'})
class TIPCommon.data_models.SLA
class TIPCommon.data_models.SLA(sla_expiration_time, critical_expiration_time, expiration_status, remaining_time_since_last_pause)
Bases: object
O SLA (Contrato de nível de serviço) encapsula as restrições de tempo e o status de um alerta. Ele oferece rastreamento de alta precisão para prazos padrão e críticos, incluindo lógica para pausas processadas.
Métodos
Os métodos a seguir gerenciam a conversão de dados de SLA entre instâncias de objetos e JSON estruturado.
| Métodos | |
|---|---|
from_json() |
Um método de classe que inicializa uma instância |
to_json() |
Converte o objeto |
Atributos
A tabela a seguir destaca os principais atributos de tempo usados para rastrear o vencimento do alerta.
| Atributos | |
|---|---|
sla_expiration_time |
O carimbo de data/hora Unix que representa o prazo de validade padrão do SLA. |
critical_expiration_time |
O carimbo de data/hora do Unix que representa o prazo de validade do SLA crítico. |
expiration_status |
O status atual do SLA. |
class TIPCommon.data_models.ScriptContext
class 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 é um contêiner abrangente que fornece o ambiente, os identificadores e os parâmetros necessários para a execução do script. Ele rastreia tudo, desde entidades de destino e IDs de fluxo de trabalho até configurações de segurança, como configurações de proxy e cofre.
Métodos
Os métodos a seguir permitem a modificação e a serialização do contexto de execução do script.
| Métodos | |
|---|---|
to_json() |
Serializa o |
update() |
Atualiza os atributos de contexto com valores de um dicionário fornecido. |
Atributos
Devido à natureza extensa do contexto, a tabela a seguir destaca os identificadores de execução e ambientais mais críticos.
| Atributos | |
|---|---|
case_id |
O identificador do caso associado à execução do script atual. |
workflow_id |
O ID do fluxo de trabalho que está sendo processado. |
parameters |
Um dicionário que contém parâmetros de tempo de execução transmitidos ao script. |
execution_deadline_unix_time_ms |
O carimbo de data/hora do Unix que indica quando a execução do script precisa ser concluída. |
vault_settings |
Configurações para acessar dados sensíveis armazenados no cofre da plataforma. |
class TIPCommon.data_models.SmimeEmailConfig
class TIPCommon.data_models.SmimeEmailConfig(email, private_key_b64, certificate_b64, ca_certificate_b64)
Bases: object
O SmimeEmailConfig encapsula os recursos criptográficos necessários e a mensagem de e-mail necessária para realizar operações S/MIME, como assinatura ou criptografia. Ele contém o e-mail bruto e as chaves e certificados codificados em base64.
Atributos
A tabela a seguir descreve os componentes criptográficos gerenciados por esse modelo de configuração.
| Atributos | |
|---|---|
email |
O objeto de mensagem de e-mail padrão do Python a ser processado. |
private_key_b64 |
A chave privada codificada em base64 usada para assinatura ou descriptografia. |
certificate_b64 |
O certificado público codificado em base64 associado à chave privada. |
ca_certificate_b64 |
O certificado da autoridade de certificação (CA) codificado em base64 usado para verificar a cadeia de confiança. |
class TIPCommon.data_models.SmimeType
class TIPCommon.data_models.SmimeType(value)
Bases: Enum
O SmimeType define o modo operacional para o processamento do S/MIME, distinguindo entre proteger o conteúdo por criptografia ou validar o remetente usando uma assinatura digital.
Constantes
As constantes a seguir representam os tipos de mensagens S/MIME compatíveis.
| Constantes | |
|---|---|
SIGNED |
'signed' (a mensagem é assinada digitalmente para garantir a autenticidade) |
ENCRYPTED |
'encrypted' (o corpo da mensagem é criptografado para
confidencialidade) |
class TIPCommon.data_models.TypedContainer
class TIPCommon.data_models.TypedContainer()
Bases: Generic[T]
O TypedContainer é um wrapper genérico projetado para armazenar dados de um tipo específico. Ele aumenta a produtividade dos desenvolvedores fornecendo dicas de tipo e IntelliSense, garantindo que o objeto armazenado seja tratado corretamente por IDEs e ferramentas de análise estática.
class TIPCommon.data_models.UserDetails
class 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
O UserDetails fornece um perfil completo de um usuário da plataforma, abrangendo metadados de autenticação, funções organizacionais e permissões granulares de acesso a dados. É essencial para gerenciar sessões de usuários e aplicar o controle de acesso baseado em papéis (RBAC).
Métodos
Os métodos a seguir facilitam a reconstrução e a serialização dos dados de perfil do usuário.
| Métodos | |
|---|---|
from_json() |
Um método de classe que inicializa uma instância |
to_json() |
Converte o objeto |
Atributos
A tabela a seguir destaca as principais estruturas de identificação e permissão do usuário.
| Atributos | |
|---|---|
user_name |
O nome de usuário exclusivo do sistema usado para login e identificação. |
soc_roles |
Uma lista de funções do SOC atribuídas ao usuário, definindo as permissões operacionais dele. |
data_access_context |
O contexto que define a quais escopos de dados e unidades organizacionais o usuário tem permissão para acessar. |
is_disabled |
Uma flag booleana que indica se a conta de usuário está restrita para fazer login. |
class TIPCommon.data_models.UserProfileCard
class TIPCommon.data_models.UserProfileCard(raw_data, first_name, last_name, user_name, account_state)
Bases: object
O UserProfileCard oferece um resumo leve do perfil de um usuário, destinado à exibição em componentes UI, como cabeçalhos ou cartões de contato, em que os detalhes completos não são necessários.
Métodos
| Métodos | |
|---|---|
from_json() |
Um método de classe que cria uma instância |
class TIPCommon.data_models.WallData
class TIPCommon.data_models.WallData(raw_data, case_id, activity_kind, activity_data_json, favorite)
Bases: object
WallData representa uma entrada no "Mural" ou na linha do tempo de um caso. Esse modelo rastreia registros de atividades, observações e ações do sistema que ocorrem durante o ciclo de vida de uma investigação.
Métodos
| Métodos | |
|---|---|
from_json() |
Um método de classe que inicializa uma instância |
to_json() |
Serializa o objeto |
Atributos
| Atributos | |
|---|---|
activity_kind |
A categoria da atividade. |
activity_data_json |
Uma string formatada em JSON que contém os detalhes ou a carga útil específicos da atividade. |
favorite |
Indica se a entrada de atividade foi fixada ou marcada como favorita para consulta rápida. |
Precisa de mais ajuda? Receba respostas de membros da comunidade e profissionais do Google SecOps.