Modulo data_models
Questo modulo contiene classi di dati per rappresentare quanto segue:
- Modelli dati
- Avvisi
- Contenitori di variabili
- Parametri generali
- Parametri del connettore
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)
Basi: object
AlertCard rappresenta una scheda riepilogativa per un avviso, che racchiude metadati e indicatori di stato critici utilizzati per la visualizzazione e il monitoraggio all'interno della piattaforma.
Metodi
I seguenti metodi facilitano la serializzazione e la ricostruzione delle schede di avviso dai dati strutturati.
| Metodi | |
|---|---|
from_json() |
Un metodo di classe che crea un'istanza |
to_json() |
Converte l'oggetto |
Attributi
La tabella seguente evidenzia gli attributi strutturali principali e i modelli di dati complessi associati all'avviso.
| Attributi | |
|---|---|
fields_groups |
Un elenco di campi raggruppati associati all'avviso, utilizzati per la presentazione dei dati strutturati nell'UI. |
sla |
L'oggetto Accordo sul livello del servizio che definisce i tempi di risposta e risoluzione per l'avviso. |
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])
Basi: object
AlertEvent rappresenta un singolo evento associato a un avviso, contenente dati di telemetria specifici, proprietà dei campi e relazioni tra entità.
Metodi
Il seguente metodo facilita la ricostruzione degli oggetti evento dai dati JSON strutturati.
| Metodi | |
|---|---|
from_json() |
Un metodo di classe che crea un'istanza |
Attributi
La tabella seguente evidenzia gli attributi strutturali principali e i modelli di dati complessi associati all'evento.
| Attributi | |
|---|---|
fields |
Un elenco di campi della proprietà specifici dell'evento, che ne definiscono i punti dati unici. |
artifact_entities |
Un elenco di identificatori di entità estratti dalla telemetria degli eventi. |
class TIPCommon.data_models.AlertPriority
class TIPCommon.data_models.AlertPriority(value)
Basi: Enum
AlertPriority definisce i livelli di gravità standardizzati basati su numeri interi utilizzati per classificare e dare la priorità agli avvisi all'interno della piattaforma.
Costanti
Le seguenti costanti rappresentano i valori di priorità specifici assegnati agli avvisi.
| Costanti | |
|---|---|
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)
Basi: object
AttachmentMetadata incapsula i dati descrittivi e le proprietà associati a un allegato di file, fornendo metodi per la conversione e il recupero dei dati strutturati.
Metodi
Il seguente metodo fornisce un modo standardizzato per ricostruire gli oggetti case dai payload JSON.
| Metodi | |
|---|---|
from_json() |
Un metodo di classe che inizializza una nuova istanza |
to_json() |
Serializza l'oggetto |
Attributi
La tabella seguente evidenzia le strutture di dati principali utilizzate per archiviare le proprietà dei metadati dell'allegato.
| Attributi | |
|---|---|
raw_data |
Il dizionario sottostante contenente gli attributi dei metadati non elaborati come ricevuti dall'origine. |
class TIPCommon.data_models.BaseAlert
class TIPCommon.data_models.BaseAlert(raw_data, alert_id)
Basi: object
BaseAlert è un modello di base che rappresenta un avviso di sicurezza generico. Fornisce una struttura standardizzata per l'archiviazione della telemetria non elaborata insieme a un identificatore univoco della piattaforma.
Metodi
Il seguente metodo consente la serializzazione dell'avviso in un formato standard.
| Metodi | |
|---|---|
to_json() |
Converte l'avviso in un dizionario serializzabile JSON restituito da
|
Attributi
La seguente tabella evidenzia i punti dati principali gestiti da questo modello.
| Attributi | |
|---|---|
raw_data |
Il payload di dati non elaborati associato all'avviso. |
alert_id |
L'identificatore univoco assegnato all'avviso. |
Esempio
L'esempio seguente mostra come inizializzare un BaseAlert e accedere ai relativi dati non elaborati e all'output serializzato.
>>> 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)
Basi: object
BaseDataModel funge da classe padre per varie strutture di dati all'interno della libreria, garantendo una gestione coerente dei dati di input non elaborati e della serializzazione.
Metodi
Il seguente metodo garantisce che i dati non elaborati vengano recuperati in un formato compatibile con le operazioni JSON.
| Metodi | |
|---|---|
to_json() |
Serializza i dati non elaborati archiviati nel modello in un formato di dizionario. |
Attributi
La seguente tabella descrive l'archiviazione dei dati principale per il modello base.
| Attributi | |
|---|---|
raw_data |
Il payload dei dati non elaborati originale utilizzato per inizializzare il modello. |
Esempio
L'esempio seguente mostra l'inizializzazione di base del modello dei dati e l'utilizzo del metodo di serializzazione.
>>> 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)
Basi: Enum
CaseDataStatus definisce gli stati operativi supportati per le richieste all'interno della piattaforma, dall'importazione iniziale alla chiusura o all'unione finale.
Costanti
Le seguenti costanti rappresentano gli indicatori di stato specifici assegnati ai dati dei casi.
| Costanti | |
|---|---|
NEW |
0 |
OPENED |
1 |
CLOSED |
2 |
ALL |
3 |
MERGED |
4 |
CREATION_PENDING |
5 |
class TIPCommon.data_models.CaseDetails
Basi: object
CaseDetails fornisce una visione completa di un caso di sicurezza, incluse le proprietà e i metodi di controllo dello stato per ricostruire o serializzare i dati del caso.
Metodi
I seguenti metodi gestiscono la conversione dei dettagli dei casi tra istanze di oggetti e formati JSON strutturati.
| Metodi | |
|---|---|
from_json() |
Un metodo di classe che inizializza un'istanza |
to_json() |
Converte l'oggetto |
Attributi
Le seguenti proprietà forniscono indicatori logici relativi allo stato attuale della richiesta.
| Attributi | |
|---|---|
is_closed |
Una proprietà booleana che indica se la richiesta è in stato chiuso. |
is_open |
Una proprietà booleana che indica se la richiesta è attiva o aperta. |
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>)
Basi: object
CaseOverviewInfo fornisce un riepilogo di alto livello di un caso di sicurezza, aggregando metadati, stato dell'accordo sul livello del servizio (SLA) e dettagli organizzativi utilizzati per la creazione di dashboard e la gestione delle code.
Metodi
Il seguente metodo facilita la ricostruzione degli oggetti di panoramica della richiesta dai dati JSON strutturati.
| Metodi | |
|---|---|
from_json() |
Un metodo di classe che inizializza un'istanza di |
Attributi
La tabella seguente evidenzia gli attributi strutturali principali, gli enum e le metriche operative chiave associati alla panoramica della richiesta.
| Attributi | |
|---|---|
priority |
Il livello di gravità assegnato alla richiesta. |
status |
Lo stato operativo attuale dei dati della richiesta. |
workflow_status |
Il passaggio o lo stato attuale all'interno del motore del workflow automatizzato della piattaforma. |
score |
Il punteggio di rischio o importanza calcolato assegnato alla richiesta. |
case_sla |
Informazioni di monitoraggio SLA specifiche per il ciclo di vita della risoluzione dei casi. |
alerts_sla |
Informazioni di monitoraggio SLA per i singoli avvisi contenuti nella richiesta. |
environment_data |
Metadati relativi all'ambiente organizzativo specifico in cui ha avuto origine la richiesta. |
tags |
Un elenco di etichette definite dall'utente o generate dal sistema associate alla richiesta. |
class TIPCommon.data_models.CasePriority
class TIPCommon.data_models.CasePriority(value)
Basi: Enum
CasePriority definisce i livelli di gravità standardizzati basati su numeri interi utilizzati per categorizzare e dare la priorità alle richieste all'interno della piattaforma.
Costanti
Le seguenti costanti rappresentano i valori di priorità specifici assegnati alle richieste.
| Costanti | |
|---|---|
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)
Basi: object
CaseSLAInfo incapsula i dati di monitoraggio dell'accordo sul livello del servizio (SLA), fornendo timestamp per la scadenza e indicatori di stato per garantire una risposta tempestiva agli incidenti.
Metodi
Il seguente metodo consente la creazione di oggetti informativi SLA da dati JSON strutturati.
| Metodi | |
|---|---|
from_json() |
Un metodo di classe che inizializza un'istanza |
Attributi
La seguente tabella evidenzia gli attributi principali di tempistica e stato utilizzati per monitorare le scadenze delle richieste.
| Attributi | |
|---|---|
expiration_time_ms |
Il timestamp Unix (in millisecondi) in cui è impostata la scadenza dello SLA standard. |
critical_expiration_time_ms |
Il timestamp Unix (in millisecondi) in cui viene raggiunta la soglia SLA critica. |
expiration_status |
Un indicatore numerico che rappresenta lo stato attuale del contratto di servizio. |
last_pause_remaining_time_ms |
Il tempo rimanente sul timer SLA al momento dell'ultima pausa. |
class TIPCommon.data_models.CaseWallAttachment
class TIPCommon.data_models.CaseWallAttachment(name, file_type, base64_blob, is_important, case_id=None, description=None)
Basi: object
CaseWallAttachment rappresenta un file o un oggetto di dati allegato alla bacheca delle prove di un caso, inclusi i contenuti non elaborati in formato Base64 e i metadati associati.
Attributi
La tabella seguente evidenzia le proprietà principali e i dati dei contenuti associati all'allegato.
| Attributi | |
|---|---|
name |
Il nome del file o il nome visualizzato dell'allegato. |
file_type |
Il tipo MIME o l'estensione del file che indica il formato dei dati allegati. |
base64_blob |
Il contenuto effettivo del file, codificato come stringa base64. |
is_important |
Un flag che indica se l'allegato è contrassegnato come prova critica per l'indagine. |
class TIPCommon.data_models.ConnectorCard
class TIPCommon.data_models.ConnectorCard(integration, display_name, identifier, is_enabled, is_remote, status)
Basi: object
ConnectorCard fornisce un riepilogo della configurazione di un connettore specifico e
stato operativo attuale all'interno della piattaforma.
Metodi
Il seguente metodo facilita la creazione di istanze di schede del connettore da dati JSON strutturati.
| Metodi | |
|---|---|
from_json() |
Un metodo di classe che inizializza un'istanza |
Attributi
La tabella seguente evidenzia lo stato operativo e le proprietà di identificazione del connettore.
| Attributi | |
|---|---|
status |
Lo stato attuale della connettività e dell'integrità del connettore. |
is_enabled |
Indica se il connettore è attivo ed elabora i dati. |
class TIPCommon.data_models.ConnectorConnectivityStatusEnum
class TIPCommon.data_models.ConnectorConnectivityStatusEnum(value)
Basi: Enum
ConnectorConnectivityStatusEnum definisce i possibili stati di connettività per un connettore, indicando se comunica correttamente con l'integrazione di destinazione.
Costanti
Le seguenti costanti rappresentano lo stato di integrità della connessione del connettore.
| Costanti | |
|---|---|
LIVE |
0 |
NO_CONNECTIVITY |
1 |
class TIPCommon.data_models.ConnectorParamTypes
class TIPCommon.data_models.ConnectorParamTypes(value)
Basi: Enum
ConnectorParamTypes definisce i tipi di dati supportati per i parametri di configurazione del connettore. Questi tipi garantiscono la corretta convalida e il rendering dell'interfaccia utente all'interno delle impostazioni della piattaforma.
Costanti
Le seguenti costanti rappresentano i tipi di dati specifici disponibili per i parametri.
| Costanti | |
|---|---|
BOOLEAN |
0 (pulsante di attivazione/disattivazione booleano) |
INTEGER |
1 (numero intero) |
STRING |
2 (stringa di testo standard) |
PASSWORD |
3 (campo password mascherata) |
IP |
4 (indirizzo IP) |
HOST |
5 (nome host) |
URL |
6 (stringa URL) |
DOMAIN |
7 (nome di dominio) |
EMAIL |
8 (indirizzo email) |
SCRIPT |
12 (parametro script legacy) |
NULL |
-1 (tipo di parametro non valido) |
class TIPCommon.data_models.ConnectorParameter
class TIPCommon.data_models.ConnectorParameter(raw_param)
Basi: parametro
ConnectorParameter rappresenta una singola impostazione di configurazione per un connettore. Estende il modello di parametri di base per includere metadati specifici come i tipi di convalida e i requisiti obbligatori.
Attributi
Le seguenti proprietà forniscono l'accesso ai dettagli di configurazione e ai vincoli del parametro del connettore.
| Attributi | |
|---|---|
name |
Il nome univoco utilizzato per identificare il parametro all'interno della configurazione del connettore. |
value |
Il valore attuale assegnato al parametro. |
type |
Il tipo di dati del parametro, utilizzato per la convalida e il rendering dell'interfaccia utente. |
mode |
La modalità operativa o l'impostazione di visibilità del parametro. |
is_mandatory |
Indica se è necessario fornire un valore per questo parametro prima che il connettore venga salvato o eseguito. |
Esempio
L'esempio seguente mostra come inizializzare un ConnectorParameter
utilizzando un dizionario non elaborato e accedere alle relative proprietà.
>>> 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()
Basi: object
Contenitore funge da oggetto generico e dinamico per archiviare le variabili come attributi. È utile per passare raccolte di dati arbitrarie tra diversi componenti della piattaforma.
Esempio
L'esempio seguente mostra come inizializzare un container e assegnare e recuperare dinamicamente una variabile.
>>> 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)
Basi: object
CreateEntity contiene le istruzioni necessarie per creare e collegare una nuova entità a un caso e un avviso esistenti. Include la logica per la mappatura di connessioni e relazioni basata su espressioni regolari.
Metodi
Il seguente metodo gestisce la conversione delle istruzioni di creazione dell'entità in un formato compatibile con la piattaforma.
| Metodi | |
|---|---|
to_json() |
Converte l'oggetto |
Attributi
La seguente tabella evidenzia le proprietà principali utilizzate per definire la nuova entità e le relative relazioni all'interno della piattaforma.
| Attributi | |
|---|---|
case_id |
L'identificatore univoco della pratica in cui verrà creata l'entità. |
alert_identifier |
L'identificatore dell'avviso a cui è associata questa entità. |
entity_type |
La classificazione dell'entità. |
entity_identifier |
Il valore o il nome specifico che identifica l'entità. |
entity_to_connect_regex |
Un'espressione regolare utilizzata per identificare altre entità a cui connettersi. |
types_to_connect |
Un elenco specifico di tipi di entità idonei per la connessione in base all'espressione regolare. |
is_primary_link |
Indica se questa connessione rappresenta la relazione principale tra le entità. |
is_directional |
Determina se la connessione ha una direzione definita (dall'origine alla destinazione) o è reciproca. |
class TIPCommon.data_models.CustomField
class TIPCommon.data_models.CustomField(id, display_name, description, type, scopes)
Basi: object
CustomField rappresenta un campo di dati definito dall'utente all'interno della piattaforma. Consente l'estensione dei modelli di dati standard aggiungendo metadati specifici adattati ai requisiti dell'organizzazione.
Metodi
Il seguente metodo consente la ricostruzione di oggetti di campi personalizzati da dati JSON strutturati.
| Metodi | |
|---|---|
from_json() |
Un metodo di classe che inizializza un'istanza |
Attributi
La tabella seguente evidenzia le proprietà principali e i vincoli di ambito del campo personalizzato.
| Attributi | |
|---|---|
id |
L'identificatore univoco del campo personalizzato. |
display_name |
L'etichetta leggibile mostrata nell'interfaccia utente della piattaforma. |
type |
Il tipo di dati del campo. |
scopes |
Un elenco delle aree di applicazione in cui è disponibile questo campo |
class TIPCommon.data_models.CustomFieldScope
class TIPCommon.data_models.CustomFieldScope(value)
Basi: Enum
CustomFieldScope definisce i target validi a cui viene applicato un campo personalizzato all'interno della gerarchia della piattaforma.
Metodi
Il seguente metodo fornisce l'utilità per risolvere il percorso dell'oggetto con ambito.
| Metodi | |
|---|---|
build_parent_path() |
Costruisce il percorso della piattaforma interna per l'identificatore dell'oggetto padre specificato. |
Costanti
Le seguenti costanti rappresentano gli ambiti specifici disponibili per i campi personalizzati.
| Costanti | |
|---|---|
ALERTS |
'Alert' |
CASE |
'Case' |
class TIPCommon.data_models.CustomFieldValue
class TIPCommon.data_models.CustomFieldValue(custom_field_id, values, scope, identifier)
Basi: object
CustomFieldValue rappresenta i dati specifici assegnati a un'istanza di campo personalizzato. Collega la definizione del campo ai contenuti effettivi forniti da un utente o da un processo automatizzato.
Metodi
Il seguente metodo facilita la ricostruzione dei valori dei campi personalizzati a partire da dati JSON strutturati.
| Metodi | |
|---|---|
from_json() |
Un metodo di classe che inizializza un'istanza |
Attributi
La tabella seguente evidenzia le proprietà principali e gli identificatori contestuali per il valore del campo personalizzato.
| Attributi | |
|---|---|
custom_field_id |
L'identificatore della definizione |
values |
Un elenco di stringhe che rappresentano i dati effettivi memorizzati nel campo. |
scope |
L'area di applicazione in cui viene applicato questo valore specifico. |
identifier |
L'identificatore univoco dell'oggetto specifico che contiene questo valore. |
class TIPCommon.data_models.DataAccessContext
class TIPCommon.data_models.DataAccessContext(global_access, assigned_scopes)
Basi: object
DataAccessContext definisce i vincoli di autorizzazione e visibilità per un utente o un processo, determinando a quali ambiti di dati è possibile accedere durante l'esecuzione.
Metodi
I seguenti metodi gestiscono la conversione dei dati del contesto di accesso tra istanze di oggetti e formati JSON.
| Metodi | |
|---|---|
from_json() |
Un metodo di classe che inizializza un'istanza |
to_json() |
Converte l'oggetto |
Attributi
La tabella seguente evidenzia i controlli di accesso principali definiti nel contesto.
| Attributi | |
|---|---|
global_access |
Indica se il contesto consente l'accesso illimitato a tutti gli ambiti di dati. |
assigned_scopes |
Un elenco di ambiti o unità organizzative specifici a cui è stato concesso esplicitamente l'accesso. |
class TIPCommon.data_models.DatabaseContextType
class TIPCommon.data_models.DatabaseContextType(value)
Basi: Enum
DatabaseContextType specifica il contesto operativo per le interazioni con il database, garantendo che i dati vengano archiviati o recuperati dal segmento logico corretto della piattaforma.
Costanti
Le seguenti costanti rappresentano le aree specifiche della piattaforma in cui si verificano le operazioni del database.
| Costanti | |
|---|---|
GLOBAL |
0 (contesto globale a livello di sistema) |
CASE |
1 (contesto specifico del caso di sicurezza) |
ALERT |
2 (contesto dell'avviso individuale) |
JOB |
3 (contesto del job pianificato o dell'automazione) |
CONNECTOR |
4 (contesto del connettore dati) |
class TIPCommon.data_models.DynamicParameter
class TIPCommon.data_models.DynamicParameter(key: str, value: str)
Basi: object
DynamicParameter rappresenta una coppia chiave-valore flessibile utilizzata per passare la configurazione di runtime o i metadati personalizzati tra i componenti del sistema.
Metodi
Il seguente metodo gestisce la ricostruzione dei parametri dinamici dai dati JSON strutturati.
| Metodi | |
|---|---|
from_json() |
Un metodo di classe che inizializza un'istanza |
Attributi
La tabella seguente descrive le proprietà del parametro dinamico.
| Attributi | |
|---|---|
key |
Il nome o l'identificatore del parametro. |
value |
I contenuti dei dati associati alla chiave. |
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)
Basi: object
EmailTemplate rappresenta un formato di comunicazione standardizzato utilizzato per notifiche e report all'interno della piattaforma. Contiene il contenuto del messaggio, i metadati e i vincoli ambientali.
Metodi
I seguenti metodi gestiscono la serializzazione e la ricostruzione dei modelli di email.
| Metodi | |
|---|---|
from_json() |
Un metodo di classe che inizializza un'istanza |
to_json() |
Converte l'oggetto |
Attributi
La tabella seguente evidenzia le proprietà principali e i dati strutturali del modello di email.
| Attributi | |
|---|---|
content |
Il corpo del testo o la struttura HTML del modello email. |
environments |
Un elenco degli ambienti dell'organizzazione in cui questo modello è disponibile per l'uso. |
template_type |
La classificazione o la categoria del modello. |
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)
Basi: object
Un'entità rappresenta un oggetto o un elemento osservabile specifico all'interno di un caso di sicurezza (ad esempio un indirizzo IP, un hash di file o un utente). Traccia sia la telemetria non elaborata sia vari "tag" booleani che indicano il ruolo o il livello di rischio dell'entità nell'indagine.
Metodi
I seguenti metodi gestiscono la serializzazione e la ricostruzione degli oggetti entità.
| Metodi | |
|---|---|
from_json() |
Un metodo di classe che inizializza un'istanza |
to_json() |
Converte l'oggetto |
Attributi
La tabella seguente evidenzia i flag di classificazione principali e le strutture di dati associati all'entità.
| Attributi | |
|---|---|
entity_type |
La categoria dell'entità. |
suspicious |
Indica se l'entità è stata segnalata come potenzialmente dannosa dalla logica di sistema o da informazioni esterne. |
vulnerable |
Indica se è noto che l'entità presenta vulnerabilità di sicurezza esistenti. |
attacker |
Contrassegnato se l'entità è identificata come l'origine di attività dannose. |
internal |
Indica se l'entità appartiene alla rete o all'infrastruttura interna dell'organizzazione. |
fields |
Un elenco di proprietà aggiuntive o punti dati arricchiti associati all'entità. |
class TIPCommon.data_models.EntityCard
class TIPCommon.data_models.EntityCard(identifier, entity_type, is_suspicious, linked_entities)
Basi: object
EntityCard rappresenta una visualizzazione riepilogativa di un'entità, in genere utilizzata per i componenti dell'interfaccia utente. Aggrega l'identificazione, il tipo e le relazioni dell'entità con altre entità in una struttura semplificata.
Metodi
I seguenti metodi gestiscono la serializzazione e la ricostruzione delle schede delle entità.
| Metodi | |
|---|---|
from_json() |
Un metodo di classe che inizializza un'istanza |
to_json() |
Converte l'oggetto |
Attributi
La seguente tabella evidenzia le proprietà principali utilizzate per identificare e collegare le entità all'interno della scheda.
| Attributi | |
|---|---|
identifier |
Il valore o il nome univoco che identifica l'entità. |
entity_type |
La categoria di classificazione dell'entità. |
is_suspicious |
Un indicatore stringa (spesso |
linked_entities |
Un elenco di identificatori per altre entità correlate a questa scheda di entità specifica. |
class TIPCommon.data_models.EnvironmentData
class TIPCommon.data_models.EnvironmentData(environment, dynamic_parameters=<factory>, base64_image=None, platform=None)
Basi: object
EnvironmentData contiene le informazioni di configurazione e branding per un ambiente organizzativo specifico. Ciò include parametri specifici dell'ambiente e asset visivi utilizzati per implementazioni multi-tenant o multi-ambiente.
Metodi
Il seguente metodo facilita la creazione di oggetti di dati sull'ambiente da dati JSON strutturati.
| Metodi | |
|---|---|
from_json() |
Un metodo di classe che inizializza un'istanza |
Attributi
La tabella seguente evidenzia i parametri di configurazione e gli asset di branding associati all'ambiente.
| Attributi | |
|---|---|
environment |
Il nome dell'ambiente organizzativo. |
dynamic_parameters |
Un elenco di coppie chiave-valore personalizzate specifiche della configurazione di questo ambiente. |
base64_image |
Una stringa con codifica base64 facoltativa che rappresenta il logo o l'icona dell'ambiente. |
platform |
Un identificatore intero che rappresenta la piattaforma o il provider di infrastrutture specifico. |
class TIPCommon.data_models.EventCard
class TIPCommon.data_models.EventCard(case_id, alert_identifier, event_id, name, time, product, port, outcome, artifact_entities, fields)
Basi: object
EventCard rappresenta un riepilogo conciso e di facile lettura di uno specifico evento di sicurezza. È progettato per mostrare la telemetria più critica, ad esempio tempistiche, prodotto di origine e risultato, da utilizzare in dashboard investigative e code di eventi.
Metodi
I seguenti metodi gestiscono la conversione dei dati delle schede evento tra istanze di oggetti e formati JSON.
| Metodi | |
|---|---|
from_json() |
Un metodo della classe che inizializza un'istanza |
to_json() |
Converte l'oggetto |
Attributi
La tabella seguente evidenzia gli identificatori principali di telemetria e organizzazione memorizzati nella scheda dell'evento.
| Attributi | |
|---|---|
event_id |
L'identificatore univoco del record evento specifico. |
time |
Il timestamp Unix che indica quando si è verificato l'evento. |
product |
Il prodotto o lo strumento di sicurezza che ha generato la telemetria dell'evento. |
outcome |
Il risultato registrato dell'evento. |
artifact_entities |
Un elenco di entità identificate nella telemetria dell'evento che fungono da artefatti per la richiesta. |
fields |
Una raccolta di proprietà chiave-valore aggiuntive specifiche per il payload di dati di questo evento. |
class TIPCommon.data_models.EventPropertyField
class TIPCommon.data_models.EventPropertyField(order, group_name, is_integration, is_highlight, items)
Basi: object
EventPropertyField definisce una raccolta strutturata di attributi evento, organizzati per priorità e raggruppamento. Viene utilizzato per classificare i dati di telemetria per la visualizzazione, evidenziando i campi critici per l'analisi.
Metodi
Il seguente metodo gestisce la ricostruzione degli oggetti campo proprietà da dati JSON strutturati.
| Metodi | |
|---|---|
from_json() |
Un metodo di classe che inizializza un'istanza |
Attributi
La tabella seguente evidenzia i metadati e gli elementi di contenuti che definiscono il campo della proprietà evento.
| Attributi | |
|---|---|
group_name |
Il nome del gruppo logico a cui appartengono questi campi. |
is_highlight |
Indica se questo campo deve essere evidenziato visivamente nell'interfaccia utente della piattaforma come punto dati ad alta priorità. |
items |
Un elenco di elementi di dati specifici contenuti in questo gruppo di proprietà. |
class TIPCommon.data_models.FieldGroupItem
class TIPCommon.data_models.FieldGroupItem(original_name, name, value)
Basi: object
FieldGroupItem rappresenta un punto dati specifico all'interno di un gruppo di campi, mantenendo una mappatura tra il nome dell'origine originale e il nome visualizzato leggibile.
Metodi
I seguenti metodi gestiscono la serializzazione e la ricostruzione degli elementi del gruppo di campi.
| Metodi | |
|---|---|
from_json() |
Un metodo di classe che inizializza un'istanza |
to_json() |
Converte l'oggetto |
class TIPCommon.data_models.FieldItem
class TIPCommon.data_models.FieldItem(original_name, name, value)
Basi: object
FieldItem è una struttura di dati di base per le singole proprietà, che memorizza la chiave non elaborata, l'etichetta mappata e il valore associato.
Metodi
| Metodi | |
|---|---|
from_json() |
Un metodo di classe che crea un'istanza |
class TIPCommon.data_models.FieldsGroup
class TIPCommon.data_models.FieldsGroup(order, group_name, is_integration, is_highlight, hide_options, items)
Basi: object
FieldsGroup funge da contenitore per organizzare più elementi di campo in una raccolta logica. Viene utilizzato principalmente per controllare il layout e la visibilità dei dati all'interno dell'interfaccia utente della piattaforma.
Metodi
I seguenti metodi gestiscono la conversione dei dati dei gruppi di campi tra istanze di oggetti e JSON strutturato.
| Metodi | |
|---|---|
from_json() |
Un metodo di classe che inizializza un'istanza |
to_json() |
Converte l'oggetto |
Attributi
La seguente tabella evidenzia le proprietà che definiscono il comportamento di visualizzazione e i contenuti del gruppo.
| Attributi | |
|---|---|
group_name |
L'etichetta utilizzata per identificare il gruppo nell'interfaccia utente. |
is_highlight |
Determina se il gruppo deve essere messo in evidenza visivamente. |
items |
Un elenco di punti dati specifici contenuti nel gruppo. |
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)
Basi: object
GoogleServiceAccount fornisce una rappresentazione strutturata delle credenziali dell'account di servizio. Google CloudViene utilizzato per gestire i dettagli di autenticazione per le integrazioni che interagiscono con i servizi Google.
Metodi
Il seguente metodo facilita l'esportazione dei dati delle credenziali nel formato standard richiesto dalle librerie client.
| Metodi | |
|---|---|
to_dict() |
Serializza le proprietà del account di servizio in un dizionario
compatibile con il formato standard |
class TIPCommon.data_models.Insight
class TIPCommon.data_models.Insight(raw_data)
Basi: object
Insight rappresenta un risultato o un'osservazione analitica discreta generata dalla piattaforma o da un'integrazione. Contiene dati non elaborati che forniscono contesto aggiuntivo o azioni consigliate per un'indagine sulla sicurezza.
Metodi
I seguenti metodi gestiscono la serializzazione e la ricostruzione degli oggetti insight.
| Metodi | |
|---|---|
from_json() |
Un metodo di classe che crea un'istanza di |
to_json() |
Serializza l'oggetto |
Attributi
| Attributi | |
|---|---|
raw_data |
Il payload dei dati non elaborati sottostanti contenente i risultati specifici e le metriche dell'approfondimento. |
class TIPCommon.data_models.InstalledIntegrationInstance
class TIPCommon.data_models.InstalledIntegrationInstance(instance, identifier, integration_identifier, environment_identifier, instance_name)
Basi: object
InstalledIntegrationInstance rappresenta un'istanza specifica e configurata di un'integrazione di cui è stato eseguito il deployment in un ambiente. Collega la definizione di integrazione generale al suo deployment e alla sua denominazione specifici per l'ambiente.
Metodi
I seguenti metodi gestiscono la conversione dei dati dell'istanza di integrazione tra istanze di oggetti e JSON strutturato.
| Metodi | |
|---|---|
from_json() |
Un metodo di classe che analizza i dati JSON in un oggetto |
to_json() |
Serializza i dati dell'istanza di integrazione in un formato di dizionario compatibile con JSON. |
Attributi
La tabella seguente mette in evidenza gli identificatori utilizzati per monitorare l'integrazione in diversi ambienti organizzativi.
| Attributi | |
|---|---|
instance_name |
Il nome definito dall'utente per questa istanza di integrazione specifica. |
integration_identifier |
L'identificatore univoco dell'integrazione principale. |
environment_identifier |
L'identificatore dell'ambiente organizzativo in cui è installata questa istanza. |
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)
Basi: object
InternalDomain rappresenta un identificatore di dominio riconosciuto come parte dell'infrastruttura interna dell'organizzazione. Questi record sono fondamentali per distinguere il traffico interno dalle minacce esterne durante le indagini sulla sicurezza.
Metodi
I seguenti metodi gestiscono la serializzazione e la ricostruzione dei record di dominio interni.
| Metodi | |
|---|---|
from_json() |
Un metodo di classe che crea un oggetto |
to_json() |
Converte l'oggetto |
Attributi
La seguente tabella evidenzia le proprietà utilizzate per identificare e classificare i domini interni.
| Attributi | |
|---|---|
domain_display_name |
Il nome del dominio principale. |
alias_name |
Un nome o un'etichetta alternativi utilizzati per identificare il dominio all'interno della piattaforma. |
environments_json |
Una stringa in formato JSON che elenca gli ambienti in cui questo dominio è considerato interno. |
class TIPCommon.data_models.JobParamType
class TIPCommon.data_models.JobParamType(value)
Basi: Enum
JobParamType definisce i tipi di dati supportati per i parametri utilizzati all'interno di job pianificati o attività di automazione. Questi tipi facilitano la corretta convalida dell'input e la gestione a livello di piattaforma.
Costanti
Le seguenti costanti rappresentano i tipi di dati specifici disponibili per i parametri del job.
| Costanti | |
|---|---|
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)
Basi: object
Parameter funge da classe base principale per tutti i modelli correlati ai parametri nella libreria. Fornisce un'interfaccia coerente per la gestione dei dati di configurazione non elaborati.
Attributi
La seguente proprietà fornisce l'accesso ai dati sottostanti utilizzati per inizializzare il parametro.
| Attributi | |
|---|---|
raw_data |
Il payload del dizionario originale contenente la configurazione del parametro. |
Esempio
L'esempio seguente mostra come inizializzare la classe Parameter di base e accedere ai relativi dati non elaborati.
>>> 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)
Basi: object
L'SLA (accordo sul livello del servizio) racchiude i vincoli temporali e lo stato di un avviso. Fornisce un monitoraggio ad alta precisione per le scadenze standard e critiche, inclusa la logica per le pause gestite.
Metodi
I seguenti metodi gestiscono la conversione dei dati SLA tra istanze di oggetti e JSON strutturato.
| Metodi | |
|---|---|
from_json() |
Un metodo di classe che inizializza un'istanza |
to_json() |
Converte l'oggetto |
Attributi
La seguente tabella evidenzia gli attributi di temporizzazione principali utilizzati per monitorare la scadenza degli avvisi.
| Attributi | |
|---|---|
sla_expiration_time |
Il timestamp Unix che rappresenta la scadenza SLA standard. |
critical_expiration_time |
Il timestamp Unix che rappresenta la scadenza dello SLA (accordo sul livello del servizio) critico. |
expiration_status |
Lo stato attuale dell'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)
Basi: object
ScriptContext è un contenitore completo che fornisce l'ambiente, gli identificatori e i parametri necessari per l'esecuzione dello script. Monitora tutto, dalle entità di destinazione e dagli ID workflow alle impostazioni di sicurezza come le configurazioni di proxy e vault.
Metodi
I seguenti metodi consentono la modifica e la serializzazione del contesto di esecuzione dello script.
| Metodi | |
|---|---|
to_json() |
Serializza |
update() |
Aggiorna gli attributi di contesto con i valori di un dizionario fornito. |
Attributi
Data la natura estesa del contesto, la tabella seguente evidenzia gli identificatori di esecuzione e ambientali più critici.
| Attributi | |
|---|---|
case_id |
L'identificatore della richiesta associata all'esecuzione dello script corrente. |
workflow_id |
L'ID del flusso di lavoro attualmente in elaborazione. |
parameters |
Un dizionario contenente i parametri runtime passati allo script. |
execution_deadline_unix_time_ms |
Il timestamp Unix che indica quando deve terminare l'esecuzione dello script. |
vault_settings |
Impostazioni di configurazione per l'accesso ai dati sensibili archiviati nel vault della piattaforma. |
class TIPCommon.data_models.SmimeEmailConfig
class TIPCommon.data_models.SmimeEmailConfig(email, private_key_b64, certificate_b64, ca_certificate_b64)
Basi: object
SmimeEmailConfig incapsula gli asset crittografici necessari e il messaggio email richiesto per eseguire operazioni S/MIME, come la firma o la crittografia. Contiene l'email non elaborata e le chiavi e i certificati con codifica Base64.
Attributi
La tabella seguente descrive i componenti crittografici gestiti da questo modello di configurazione.
| Attributi | |
|---|---|
email |
L'oggetto messaggio email Python standard da elaborare. |
private_key_b64 |
La chiave privata con codifica Base64 utilizzata per la firma o la decrittografia. |
certificate_b64 |
Il certificato pubblico con codifica Base64 associato alla chiave privata. |
ca_certificate_b64 |
Il certificato dell'autorità di certificazione (CA) con codifica base64 utilizzato per verificare la catena di attendibilità. |
class TIPCommon.data_models.SmimeType
class TIPCommon.data_models.SmimeType(value)
Basi: Enum
SmimeType definisce la modalità operativa per l'elaborazione S/MIME, distinguendo tra la protezione dei contenuti tramite crittografia e la convalida del mittente tramite una firma digitale.
Costanti
Le seguenti costanti rappresentano i tipi di messaggi S/MIME supportati.
| Costanti | |
|---|---|
SIGNED |
'signed' (Il messaggio è firmato digitalmente per garantire
l'autenticità) |
ENCRYPTED |
'encrypted' (Il corpo del messaggio è criptato per
garantire la riservatezza) |
class TIPCommon.data_models.TypedContainer
class TIPCommon.data_models.TypedContainer()
Basi: Generic[T]
TypedContainer è un wrapper generico progettato per contenere dati di un tipo specifico. Migliora la produttività degli sviluppatori fornendo suggerimenti sui tipi e intellisense, garantendo che l'oggetto archiviato venga trattato correttamente da IDE e strumenti di analisi statica.
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)
Basi: object
UserDetails fornisce un profilo esaustivo di un utente della piattaforma, che comprende metadati di autenticazione, ruoli organizzativi e autorizzazioni di accesso ai dati granulari. È essenziale per gestire le sessioni utente e applicare controllo dell'accesso basato sui ruoli (RBAC).
Metodi
I seguenti metodi facilitano la ricostruzione e la serializzazione dei dati del profilo utente.
| Metodi | |
|---|---|
from_json() |
Un metodo di classe che inizializza un'istanza |
to_json() |
Converte l'oggetto |
Attributi
La tabella seguente evidenzia le strutture principali di identificazione e autorizzazione per l'utente.
| Attributi | |
|---|---|
user_name |
Il nome utente univoco del sistema utilizzato per l'accesso e l'identificazione. |
soc_roles |
Un elenco di ruoli SOC assegnati all'utente, che definiscono le sue autorizzazioni operative. |
data_access_context |
Il contesto che definisce gli ambiti di dati e le unità organizzative a cui l'utente è autorizzato ad accedere. |
is_disabled |
Un flag booleano che indica se l'accesso all'account utente è attualmente limitato. |
class TIPCommon.data_models.UserProfileCard
class TIPCommon.data_models.UserProfileCard(raw_data, first_name, last_name, user_name, account_state)
Basi: object
UserProfileCard fornisce un riepilogo leggero del profilo di un utente, destinato alla visualizzazione in componenti UI come intestazioni o schede di contatto in cui non sono necessari tutti i dettagli.
Metodi
| Metodi | |
|---|---|
from_json() |
Un metodo di classe che crea un'istanza |
class TIPCommon.data_models.WallData
class TIPCommon.data_models.WallData(raw_data, case_id, activity_kind, activity_data_json, favorite)
Basi: object
WallData rappresenta una voce nella "Bacheca" o nella cronologia di una richiesta. Questo modello tiene traccia dei log attività, delle note e delle azioni di sistema che si verificano durante il ciclo di vita di un'indagine.
Metodi
| Metodi | |
|---|---|
from_json() |
Un metodo di classe che inizializza un'istanza di |
to_json() |
Serializza l'oggetto |
Attributi
| Attributi | |
|---|---|
activity_kind |
La categoria dell'attività. |
activity_data_json |
Una stringa formattata in JSON contenente i dettagli o il payload specifici dell'attività. |
favorite |
Indica se la voce dell'attività è stata bloccata o contrassegnata come preferita per una consultazione rapida. |
Hai bisogno di ulteriore assistenza? Ricevi risposte dai membri della community e dai professionisti di Google SecOps.