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: int, workflow_status: int, 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, playbook_attached: str | None, playbook_run_count: int, is_manual_alert: bool, sla: SLA, fields_groups: list[FieldsGroup], source_url: str | None, source_rule_url: str | None, siem_alert_id: str | None)

Base: object

Rappresenta una scheda riepilogativa di un avviso, contenente i relativi dettagli e metadati chiave.

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

Crea un oggetto AlertCard da un dizionario JSON che ne rappresenta gli attributi.

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])

Base: object

Rappresenta un singolo evento associato a un avviso all'interno di un caso.

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

Crea un oggetto AlertEvent da un dizionario JSON.

class TIPCommon.data_models.AlertPriority

class TIPCommon.data_models.AlertPriority(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Basi: Enum

Rappresenta i livelli di priorità per un avviso.

Costanti

• CRITICAL = 100

• HIGH = 80

• INFORMATIVE = -1

• LOW = 40

• MEDIUM = 60

• UNCHANGED = 0

class TIPCommon.data_models.BaseAlert

class TIPCommon.data_models.BaseAlert(raw_data, alert_id)

Base: object

Rappresenta un avviso di base. Ha le seguenti proprietà:

Attributi

raw_data	I dati non elaborati per l'avviso.
alert_id	L'ID dell'avviso.

Metodi

• to_json()→ dict

Nota: il metodo to_json converte l'avviso in formato JSON come restituito da json.loads().

Esempio

>>> 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)

Base: object

Rappresenta un modello dei dati di base.

Attributi

Attributo	Descrizione
raw_data	I dati non elaborati per il modello dei dati.

Metodi

• to_json()→ dict

Nota: il metodo to_json converte i dati non elaborati in formato JSON come restituito da json.loads().

Esempio

>>> 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, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Basi: Enum

Costanti

• ALL = 3

• CLOSED = 2

• CREATION_PENDING = 5

• MERGED = 4

• NEW = 0

• OPENED = 1

class TIPCommon.data_models.CaseDetails

class TIPCommon.data_models.CaseDetails(id_: int, creation_time_unix_time_ms: int, modification_time_unix_time_ms: int, name: str, priority: int, is_important: bool, is_incident: bool, start_time_unix_time_ms: int, end_time_unix_time_ms: int, assigned_user: str, description: str | None, is_test_case: bool, type_: int, stage: str, environment: str, status: CaseDataStatus, incident_id: int | None, tags: list[str], alerts: list[AlertCard], is_overflow_case: bool, is_manual_case: bool, sla_expiration_unix_time: int | None, sla_critical_expiration_unix_time: int | None, stage_sla_expiration_unix_time_ms: int | None, stage_sla__critical_expiration_unix_time_in_ms: int | None, can_open_incident: bool, sla:SLA, stage_sla: SLA)

Base: object

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

Crea un oggetto CaseDetails da un dizionario JSON.

property is_closed

property is_closed: bool

Indica se la richiesta è chiusa.

property is_open

property is_open: bool

Indica se la richiesta è aperta.

class TIPCommon.data_models.CasePriority

class TIPCommon.data_models.CasePriority(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Basi: Enum

Rappresenta i livelli di priorità per un avviso.

Costanti

• CRITICAL = 100

• HIGH = 80

• INFORMATIVE = -1

• LOW = 40

• MEDIUM = 60

• UNCHANGED = 0

class TIPCommon.data_models.CaseWallAttachment

class TIPCommon.data_models.CaseWallAttachment(name: 'str', file_type: 'str', base64_blob: 'str', is_important: 'bool', case_id: 'int | None' = None)

Base: object

Rappresenta un allegato da aggiungere a una bacheca richieste.

Attributi

Attributo	Descrizione	Tipo
base64_blob	I contenuti codificati in base64 dell'allegato.	str
case_id	L'ID della richiesta a cui appartiene l'allegato.	int | None
file_type	Il tipo di file dell'allegato.	str
is_important	Indica se l'allegato è contrassegnato come importante.	bool
name	Il nome del file allegato.	str

class TIPCommon.data_models.ConnectorCard

class TIPCommon.data_models.ConnectorCard(integration: str, display_name: str, identifier: str, is_enabled: bool, is_remote: bool, status: ConnectorConnectivityStatusEnum)

Base: object

Rappresenta una scheda riepilogativa per un'istanza del connettore.

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

Crea un oggetto ConnectorCard da un dizionario JSON.

class TIPCommon.data_models.ConnectorConnectivityStatusEnum

class TIPCommon.data_models.ConnectorConnectivityStatusEnum(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Basi: Enum

Rappresenta lo stato di connettività di un connettore.

Costanti

• LIVE = 0

• NO_CONNECTIVITY = 1

class TIPCommon.data_models.ConnectorParamTypes

class TIPCommon.data_models.ConnectorParamTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Basi: Enum

Costanti

Rappresenta i tipi di parametri del connettore.

• BOOLEAN = 0

• DOMAIN = 7

• EMAIL = 8

• HOST = 5

• INTEGER = 1

• IP = 4

• NULL = -1

• PASSWORD = 3

• SCRIPT = 12

• STRING = 2

• URL = 6

class TIPCommon.data_models.ConnectorParameter

class TIPCommon.data_models.ConnectorParameter(raw_param)

Basi: Parametro

Rappresenta un parametro del connettore.

Attributi

Attributo	Descrizione
name	Il nome del parametro.
value	Il valore del parametro.
type	Il tipo di parametro (in base a ConnectorParamTypes).
mode	La modalità del parametro.
is_mandatory	Definisci se il parametro è obbligatorio.

Esempio

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

class TIPCommon.data_models.Container

Base: object

Rappresenta un contenitore per le variabili.

Esempio

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

class TIPCommon.data_models.CustomField

class TIPCommon.data_models.CustomField(id: 'int', display_name: 'str', description: 'str', type: 'str', scopes: 'list[CustomFieldScope]')

Base: object

Rappresenta una definizione di campo personalizzato all'interno della piattaforma.

Attributi

Attributo	Descrizione
description	str La descrizione del campo personalizzato.
display_name	str Il nome visualizzato del campo personalizzato.
id	int L'ID univoco del campo personalizzato.
scopes	list[CustomFieldScope] Gli ambiti (ad es. Avviso, Richiesta) in cui è applicabile il campo personalizzato.
type	str Il tipo di dati del campo personalizzato.

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

Crea un oggetto CustomField da un dizionario JSON.

class TIPCommon.data_models.CustomFieldScope

class TIPCommon.data_models.CustomFieldScope(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Basi: Enum

Rappresenta gli ambiti possibili in cui è possibile applicare un campo personalizzato.

Costanti

• ALERTS = 'Alert'

• CASE = 'Case'

Metodi

• build_parent_path(identifier: int)→ str Crea il percorso principale per il valore del campo personalizzato in base all'identificatore.

class TIPCommon.data_models.CustomFieldValue

class TIPCommon.data_models.CustomFieldValue(custom_field_id: 'int', values: 'list[str]', scope: 'CustomFieldScope', identifier: 'int')

Base: object

Rappresenta il valore impostato per un campo personalizzato specifico.

Attributi

Attributo	Descrizione
custom_field_id	int L'ID del campo personalizzato.
identifier	int L'ID dell'entità (richiesta/avviso) a cui appartiene il valore.
scope	CustomFieldScope L'ambito (ad es. Avviso, Richiesta) a cui si applica il valore del campo personalizzato.
values	list[str] L'elenco dei valori impostati per il campo personalizzato.

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

Crea un oggetto CustomFieldValue da un dizionario JSON.

class TIPCommon.data_models.DatabaseContextType

class TIPCommon.data_models.DatabaseContextType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Basi: Enum

Rappresenta i tipi di contesti di database per l'archiviazione dei dati.

Costanti

• ALERT = 2

• CASE = 1

• CONNECTOR = 4

• GLOBAL = 0

• JOB = 3

class TIPCommon.data_models.EventPropertyField

class TIPCommon.data_models.EventPropertyField(order: int, group_name: str, is_integration: bool, is_highlight: bool, items: list[FieldItem])

Base: object

Rappresenta un gruppo di campi all'interno delle proprietà di un evento.

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

Crea un oggetto EventPropertyField da un dizionario JSON.

class TIPCommon.data_models.FieldGroupItem

class TIPCommon.data_models.FieldGroupItem(original_name: str, name: str, value: str)

Base: object

Rappresenta un singolo elemento chiave-valore all'interno del gruppo di campi di un evento.

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

Crea un oggetto FieldGroupItem da un dizionario JSON.

class TIPCommon.data_models.FieldItem

class TIPCommon.data_models.FieldItem(original_name: str, name: str, value: str)

Base: object

Rappresenta un singolo elemento all'interno di un campo, contenente il nome originale, il nome formattato e il valore.

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

Crea un oggetto FieldItem da un dizionario JSON.

class TIPCommon.data_models.FieldsGroup

class TIPCommon.data_models.FieldsGroup(order: int, group_name: str, is_integration: bool, is_highlight: bool, items: list[[FieldGroupItem]])

Base: object

Rappresenta un gruppo di campi all'interno di una struttura di dati più grande, spesso utilizzato per la visualizzazione.

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

Crea un oggetto FieldsGroup da un dizionario JSON.

class TIPCommon.data_models.GoogleServiceAccount

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

Base: object

Rappresenta gli attributi di un service account Google.

Metodi

• to_dict()→ dict Serializza il modello dei dati in un dizionario.

Restituisce

Un dizionario JSON dell'account di servizio.

Tipo restituito

dict

class TIPCommon.data_models.InstalledIntegrationInstance

class TIPCommon.data_models.InstalledIntegrationInstance(instance: MutableMapping[str, Any], identifier: str, integration_identifier: str, environment_identifier: str, instance_name: str)

Base: object

Rappresenta un'istanza installata di un'integrazione all'interno di un ambiente.

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

Crea un oggetto InstalledIntegrationInstance da un dizionario JSON.

Parametri

Parametri
integration_env_json	SingleJson Dati JSON contenenti informazioni sull'ambiente di integrazione.

Restituisce

Un'istanza della classe specificata inizializzata con i dati di raw_data.

Tipo restituito

InstalledIntegrationInstance

class TIPCommon.data_models.JobParamType

class TIPCommon.data_models.JobParamType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Basi: Enum

Costanti

• BOOLEAN = 0

• DOMAIN = 7

• HOST = 5

• INTEGER = 1

• IP = 4

• NULL = -1

• PASSWORD = 3

• STRING = 2

• URL = 6

class TIPCommon.data_models.Parameter

class TIPCommon.data_models.Parameter(raw_param)

Base: object

Una classe padre che rappresenta un parametro.

Attributi

Attributo	Descrizione
raw_data	I dati non elaborati per il parametro.

Esempio

>>> 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: int | None, critical_expiration_time: int | None, expiration_status: int, remaining_time_since_last_pause: int | None)

Base: object

Rappresenta i dettagli dell'accordo sul livello del servizio (SLA) per una richiesta o un avviso.

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

Crea un oggetto SLA da un dizionario JSON.

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)

Base: object

Rappresenta il contesto di esecuzione di uno script o di un'azione, fornendo l'accesso a vari parametri e dati di runtime.

Attributi

Attributo	Descrizione
action_definition_name	str Il nome della definizione dell'azione in esecuzione. Il valore predefinito è ''.
alert_id	str L'ID dell'avviso associato all'esecuzione corrente. Il valore predefinito è ''.
async_polling_interval_in_sec	int L'intervallo per il polling asincrono in secondi. Il valore predefinito è 0.
async_total_duration_deadline	int Il termine di durata totale per le operazioni asincrone. Il valore predefinito è 0.
case_id	int | str | None L'ID della richiesta associata all'esecuzione corrente. Il valore predefinito è None.
connector_context	ConnectorContext | None Un contesto specifico per l'esecuzione del connettore. Il valore predefinito è None.
default_result_value	str Il valore predefinito per il risultato dell'azione. Il valore predefinito è ''.
environment	str L'ambiente di esecuzione. Il valore predefinito è ''.
environment_api_key	str | None La chiave API per l'ambiente. Il valore predefinito è None.
execution_deadline_unix_time_ms	int Il timestamp Unix (in millisecondi) che indica la scadenza dell'esecuzione. Il valore predefinito è 0.
integration_identifier	str L'identificatore dell'integrazione in uso. Il valore predefinito è ''.
integration_instance	str Il nome dell'istanza di integrazione in uso. Il valore predefinito è ''.
job_api_key	str Chiave API specifica per il job. Il valore predefinito è ''.
max_json_result_size	int La dimensione massima consentita per i risultati JSON. Il valore predefinito è 15.
original_requesting_user	str L'utente che ha avviato originariamente la richiesta. Il valore predefinito è ''.
parameters	SingleJson Un oggetto JSON contenente i parametri per lo script/l'azione.
script_timeout_deadline	int La scadenza per il timeout di esecuzione dello script. Il valore predefinito è 0.
target_entities	str Stringa separata da virgole delle entità di destinazione. Il valore predefinito è ''.
unique_identifier	str Un identificatore univoco per il contesto di esecuzione. Il valore predefinito è ''.
use_proxy_settings	bool Indica se devono essere utilizzate le impostazioni proxy. Il valore predefinito è False.
vault_settings	SiemplifyVault | None Impostazioni di Vault per il recupero sicuro delle credenziali. Il valore predefinito è None.
workflow_id	str L'ID del flusso di lavoro. Il valore predefinito è ''.
workflow_instance_id	str | None L'ID dell'istanza del flusso di lavoro. Il valore predefinito è None.

Metodi

• to_json()→ MutableMapping[str, Any] Serializza l'oggetto contesto in una mappatura modificabile (dizionario JSON).

• update(attributes: MutableMapping[str, Any])→ None Aggiorna l'oggetto contesto con nuovi attributi da una mappatura modificabile.

class TIPCommon.data_models.SmimeEmailConfig

class TIPCommon.data_models.SmimeEmailConfig(email: 'email.message.Message', private_key_b64: 'str', certificate_b64: 'str', ca_certificate_b64: 'str')

Base: object

Rappresenta la configurazione per l'invio di email criptate o firmate con S/MIME.

Attributi

Attributo	Descrizione
ca_certificate_b64	str Il certificato CA con codifica Base64.
certificate_b64	str Il certificato con codifica Base64.
email	Message L'oggetto del messaggio email.
private_key_b64	str La chiave privata con codifica Base64.

class TIPCommon.data_models.SmimeType

class TIPCommon.data_models.SmimeType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Basi: Enum

Rappresenta i tipi di operazioni S/MIME.

Costanti

• ENCRYPTED = 'encrypted'

• SIGNED = 'signed'

class TIPCommon.data_models.TypedContainer

class TIPCommon.data_models.TypedContainer(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Basi: Generic[T]

Contenitore per un tipo specifico che fornisce il completamento automatico del tipo.

class TIPCommon.data_models.UserProfileCard

class TIPCommon.data_models.UserProfileCard(raw_data: dict, first_name: str, last_name: str, user_name: str, account_state: int)

Base: object

Rappresenta una scheda riepilogativa del profilo utente.

classmethod from_json(user_profile_card_response: dict)→ UserProfileCard

Crea un oggetto UserProfileCard da un dizionario JSON.

Hai bisogno di ulteriore assistenza? Ricevi risposte dai membri della community e dai professionisti di Google SecOps.