Cette page a été traduite par l'API Cloud Translation.

Module soar_ops

TIPCommon.soar_ops.create_slo_message

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

Obtient les messages d'avertissement de SLO en fonction des intervalles de temps et des commentaires existants.

Pour le paramètre interval_days=[0, 1, 7, 14], la fonction envoie un message d'avertissement indiquant que le SLO sera enfreint selon le calendrier suivant :

7 à 14 jours avant l'heure d'expiration
1 à 7 jours avant la date d'expiration.
Date et heure de la violation du SLO.

Si un commentaire a déjà été envoyé au cours de l'intervalle concerné, aucun nouveau commentaire n'est renvoyé (None est renvoyé).

Paramètres
`slo`	`int` Date de non-respect du SLO en microsecondes Unix (par exemple, 1_673_774_674_567)
`interval_days`	`Iterable[int]` Un itérable contenant le nombre de jours à partir duquel les avertissements de non-respect du délai doivent être envoyés (par exemple, [0, 1, 3, 7, 14])
`existing_comments`	`Iterable[int]` Les commentaires existants pour vérifier si un commentaire a déjà été envoyé.

Génère

ValueError : lorsqu'un des intervalles de temps est négatif.

Renvoie

Le commentaire est renvoyé, le cas échéant. Sinon, None est renvoyé.

TIPCommon.soar_ops.get_clean_comment_body

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

Supprime un préfixe de la chaîne de commentaire ou de l'objet de commentaire.

Paramètres
`comment`	`str \| CaseComment` Chaîne ou objet de commentaire dont le préfixe doit être supprimé.
`prefix`	`str` Préfixe à supprimer.

Génère

TypeError : lorsque le type de commentaire n'est ni str ni CaseComment.

Renvoie

Commentaire sans le préfixe.

Type renvoyé

str

TIPCommon.soar_ops.get_file

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

Renvoie le contenu du fichier en octets.

Paramètres

Paramètres
`chronicle_soar`	`ChronicleSOAR` Objet SDK Google Security Operations SOAR.
`identifier`	`str` Identifiant du nom de fichier avec le chemin d'accès complet.

Renvoie

Données en octets de l'identifiant fourni.

Type renvoyé

bytes | None

TIPCommon.soar_ops.get_secops_mode

TIPCommon.soar_ops.get_secops_mode()→ str | None

Renvoie la variable d'environnement SECOPS_MODE.

Renvoie

Variable d'environnement SECOPS_MODE.

Type renvoyé

str | None

TIPCommon.soar_ops.get_soar_case_comments

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

Renvoie une liste d'objets de commentaires d'une demande à l'aide de son ID.

Paramètres
`chronicle_soar`	`SiemplifyAction \| SiemplifyJob` Objet SDK.
`case_id`	`str \| int` ID de la demande dont les commentaires sont récupérés.

Renvoie

Liste d'objets de commentaires.

Type renvoyé

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

Obtient un objet UserProfileCard à partir d'un ID utilisateur.

Paramètres

Paramètres
`chronicle_soar`	`ChronicleSOAR` Objet SDK Google Security Operations SOAR.
`user_id`	`str` ID utilisateur, par exemple `f6dc053c-58bb-4da5-95bb-739be7d297a2`.

Renvoie

Objet utilisateur s'il est trouvé, sinon None.

Type renvoyé

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]

Récupère toutes les fiches de profil utilisateur à l'aide de la pagination. La taille de la page sert de limite au nombre d'utilisateurs dans chaque itération.

Paramètres

Paramètres
`chronicle_soar`	`ChronicleSOAR` Objet SDK Google Security Operations SOAR.
`search_term`	`str` Termes de recherche. La valeur par défaut est `''`.
`page_size`	`int` Nombre d'utilisateurs à renvoyer. La valeur par défaut est `20`.
`filter_by_role`	`bool` Définissez si vous souhaitez filtrer par rôle. La valeur par défaut est `False`.
`filter_disabled_users`	`bool` Définissez si vous souhaitez filtrer les utilisateurs désactivés. La valeur par défaut est `False`.
`filter_support_users`	`bool` Définissez si vous souhaitez filtrer les utilisateurs de l'assistance. La valeur par défaut est `False`.
`fetch_only_support_users`	`bool` Définissez si vous souhaitez renvoyer uniquement les utilisateurs de l'assistance. La valeur par défaut est `False`.
`filter_permission_types`	`list[int] \| None` Liste des types d'autorisations de filtre (par exemple, `0`). La valeur par défaut est `None`.

Renvoie

Liste de tous les utilisateurs.

Type renvoyé

list[UserProfileCard]

TIPCommon.soar_ops.is_slo_comment

TIPCommon.soar_ops.is_slo_comment(comment: str)

Vérifie si un commentaire est un commentaire d'avertissement SLO.

Un commentaire SLO est soit un avertissement SLO ("Le SLO sera enfreint dans {int} jours"), soit un message SLO enfreint ("Le SLO a été enfreint").

Paramètres
`comment`	`str` Commentaire à vérifier.

Renvoie

True si le commentaire est un commentaire SLO. Sinon, False est renvoyé.

Type renvoyé

bool

TIPCommon.soar_ops.remove_prefix_from_comments

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

Supprime un préfixe (le cas échéant) d'une liste de commentaires.

Paramètres
`comments`	`list[str]` Commentaires dont le préfixe doit être supprimé.
`prefix`	`str` Préfixe à supprimer.

Renvoie

Liste de tous les commentaires après la suppression du préfixe

Type renvoyé

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

Enregistre un fichier dans un bucket Google Cloud ou un chemin d'accès local.

Paramètres

Paramètres
`chronicle_soar`	`ChronicleSOAR` Objet SDK Google Security Operations SOAR.
`path`	`str` Chemin d'accès au dossier dans lequel les fichiers doivent être enregistrés.
`name`	`str` Nom du fichier à enregistrer.
`content`	`bytes` Contenu du fichier au format octets.

Renvoie

Chemin d'accès aux fichiers téléchargés.

Type renvoyé

str | None

Vous avez encore besoin d'aide ? Obtenez des réponses de membres de la communauté et de professionnels Google SecOps.