modulo soar_ops

TIPCommon.soar_ops.create_slo_message

TIPCommon.soar_ops.create_slo_message(slo: int, interval_days: Iterable[int], existing_comments: Iterable[str])

Riceve messaggi di avviso SLO in base agli intervalli di tempo e ai commenti esistenti.

Per il parametro interval_days=[0, 1, 7, 14], la funzione invia un messaggio di avviso che l'SLO verrà violato in base alla seguente pianificazione:

7-14 giorni prima della scadenza.
1-7 giorni prima dell'ora di scadenza.
Quando è stato violato l'SLO.

Se un commento è già stato inviato nell'intervallo violato corrente, non viene restituito alcun nuovo commento (viene restituito None).

Parametri
`slo`	`int` La data di violazione dell'SLO in microsecondi Unix (ad esempio, 1_673_774_674_567)
`interval_days`	`Iterable[int]` Un iterabile contenente il numero di giorni a partire dai quali devono essere inviati gli avvisi di violazione dei tempi (ad esempio, [0, 1, 3, 7, 14])
`existing_comments`	`Iterable[int]` I commenti esistenti per verificare se un commento è già stato inviato.

Aumenti

ValueError: quando uno degli intervalli di tempo è negativo.

Restituisce

Il commento viene restituito, se applicabile. In caso contrario, viene restituito None.

TIPCommon.soar_ops.get_clean_comment_body

TIPCommon.soar_ops.get_clean_comment_body(comment: str | CaseComment, prefix: str)

Rimuove un prefisso dalla stringa di commento o dall'oggetto commento.

Parametri
`comment`	`str \| CaseComment` La stringa di commento o l'oggetto commento da cui rimuovere il prefisso.
`prefix`	`str` Il prefisso da rimuovere.

Aumenti

TypeError: quando il tipo di commento non è né str né CaseComment.

Restituisce

Il commento senza il prefisso.

Tipo restituito

str

TIPCommon.soar_ops.get_file

TIPCommon.soar_ops.get_file(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, identifier: str)→ bytes | None

Restituisce il contenuto del file in byte.

Parametri

Parametri
`chronicle_soar`	`ChronicleSOAR` Un oggetto Google SecOps SDK.
`identifier`	`str` L'identificatore del nome file insieme al percorso completo.

Restituisce

Byte di dati dell'identificatore fornito.

Tipo restituito

bytes | None

TIPCommon.soar_ops.get_secops_mode

TIPCommon.soar_ops.get_secops_mode()→ str | None

Restituisce la variabile di ambiente SECOPS_MODE.

Restituisce

La variabile di ambiente SECOPS_MODE.

Tipo restituito

str | None

TIPCommon.soar_ops.get_soar_case_comments

TIPCommon.soar_ops.get_soar_case_comments(chronicle_soar: SiemplifyAction | SiemplifyJob, case_id: str | int)

Restituisce un elenco di oggetti commento da una richiesta, utilizzando il relativo ID.

Parametri
`chronicle_soar`	`SiemplifyAction \| SiemplifyJob` L'oggetto SDK.
`case_id`	`str \| int` L'ID della richiesta di cui vengono recuperati i commenti.

Restituisce

Un elenco di oggetti commento.

Tipo restituito

list[base.action.CaseComment]

TIPCommon.soar_ops.get_user_by_id

TIPCommon.soar_ops.get_user_by_id(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, user_id: str)→ UserProfileCard | None

Recupera un oggetto Python del modello di dati UserProfileCard da un ID utente.

Parametri

Parametri
`chronicle_soar`	`ChronicleSOAR` Un oggetto Google SecOps SDK.
`user_id`	`str` L'ID utente. Ad esempio, `f6dc053c-58bb-4da5-95bb-739be7d297a2`.

Restituisce

L'oggetto modello di dati UserProfileCard se user_id esiste nella piattaforma; altrimenti, viene restituito None.

L'attributo raw_data dell'oggetto UserProfileCard contiene i dettagli dell'utente in formato JSON.

Esempio di risposta JSON in `user.raw_data`:

Il seguente esempio mostra la struttura della risposta JSON per l'attributo raw_data:

{
    "name": "projects/project/locations/location/instances/instance/legacySoarUsers/1",
    "id": 1,
    "displayName": "84b44ee6-d372-43c9-8abe-ae14b8421492",
    "permissionGroups": [
        {
            "id": 1,
            "name": "Admins"
        }
    ],
    "lastLoginTime": 1769503546327,
    "userFullName": "Test Admin",
    "socRoles": [1],
    "email": "admin@example.com",
    "userType": "Internal",
    "environmentsJson": "[\"*\"]",
    "accountState": "Active",
    "providerName": "Internal",
    "allowedPlatforms": [0],
    "loginIdentifier": "admin@example.com",
    "firstName": "Test",
    "lastName": "Admin"
}

Tipo restituito

UserProfileCard | None

TIPCommon.soar_ops.get_users_profile_cards_with_pagination

TIPCommon.soar_ops.get_users_profile_cards_with_pagination(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, search_term: str = '', page_size: int = 20, filter_by_role: bool = False, filter_disabled_users: bool = False, filter_support_users: bool = False, fetch_only_support_users: bool = False, filter_permission_types: list[int] | None = None)→ list[UserProfileCard]

Recupera tutte le schede del profilo utente utilizzando la paginazione. La dimensione della pagina funge da limite per il numero di utenti in ogni iterazione.

Parametri

Parametri
`chronicle_soar`	`ChronicleSOAR` Un oggetto Google SecOps SDK.
`search_term`	`str` I termini di ricerca. Il valore predefinito è `''`.
`page_size`	`int` Il numero di utenti da restituire. Il valore predefinito è `20`.
`filter_by_role`	`bool` Definisci se filtrare per ruolo. Il valore predefinito è `False`.
`filter_disabled_users`	`bool` Definisci se filtrare gli utenti disattivati. Il valore predefinito è `False`.
`filter_support_users`	`bool` Definisci se filtrare gli utenti dell'assistenza. Il valore predefinito è `False`.
`fetch_only_support_users`	`bool` Definisci se restituire solo gli utenti di assistenza. Il valore predefinito è `False`.
`filter_permission_types`	`list[int] \| None` Un elenco di tipi di autorizzazione per i filtri (ad es. `0`). Il valore predefinito è `None`.

Restituisce

Un elenco di tutti gli utenti.

Tipo restituito

list[UserProfileCard]

TIPCommon.soar_ops.is_slo_comment

TIPCommon.soar_ops.is_slo_comment(comment: str)

Controlla se un commento è un avviso SLO.

Un commento SLO è un avviso SLO ("L'SLO verrà violato tra {int} giorni") o un messaggio di violazione SLO ("L'SLO è stato violato").

Parametri
`comment`	`str` Il commento da controllare.

Restituisce

True se il commento è un commento SLO. In caso contrario, viene restituito False.

Tipo restituito

bool

TIPCommon.soar_ops.remove_prefix_from_comments

TIPCommon.soar_ops.remove_prefix_from_comments(comments: list[str], prefix: str)

Rimuove un prefisso (se presente) da un elenco di commenti.

Parametri
`comments`	`list[str]` I commenti da cui rimuovere il prefisso.
`prefix`	`str` Il prefisso da rimuovere.

Restituisce

Un elenco di tutti i commenti dopo la rimozione del prefisso

Tipo restituito

list[str]

TIPCommon.soar_ops.save_file

TIPCommon.soar_ops.save_file(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, path: str, name: str, content: bytes)→ bytes | None

Salva un file in un bucket Google Cloud o in un percorso locale.

Parametri

Parametri
`chronicle_soar`	`ChronicleSOAR` Un oggetto Google SecOps SDK.
`path`	`str` Il percorso della cartella in cui devono essere salvati i file.
`name`	`str` Il nome del file da salvare.
`content`	`bytes` Il contenuto del file in formato byte.

Restituisce

Il percorso dei file scaricati.

Tipo restituito

str | None

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

modulo soar_ops

TIPCommon.soar_ops.create_slo_message

Aumenti

Restituisce

TIPCommon.soar_ops.get_clean_comment_body

Aumenti

Restituisce

Tipo restituito

TIPCommon.soar_ops.get_file

Parametri

Restituisce

Tipo restituito

TIPCommon.soar_ops.get_secops_mode

Restituisce

Tipo restituito

TIPCommon.soar_ops.get_soar_case_comments

Restituisce

Tipo restituito

TIPCommon.soar_ops.get_user_by_id

Parametri

Restituisce

Esempio di risposta JSON in user.raw_data:

Tipo restituito

TIPCommon.soar_ops.get_users_profile_cards_with_pagination

Parametri

Restituisce

Tipo restituito

TIPCommon.soar_ops.is_slo_comment

Restituisce

Tipo restituito

TIPCommon.soar_ops.remove_prefix_from_comments

Restituisce

Tipo restituito

TIPCommon.soar_ops.save_file

Parametri

Restituisce

Tipo restituito

Esempio di risposta JSON in `user.raw_data`: