Module Siemplify

classe Siemplify.Siemplify

Bases : SiemplifyBase

Points de terminaison : external/v1/sdk/CaseFullDetails

add_agent_connector_logs

add_agent_connector_logs(agent_id, connector_id, logs_package)

Ajoutez les journaux du connecteur connector_id de l'agent distant.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
agent_id	{string}	Identifiant de l'agent	N/A	N/A
connector_id	{string}	Identifiant de l'instance de connecteur	N/A	N/A
logs_package	{dict}	ConnectorLogPackage	N/A	N/A

add_attachment

add_attachment(file_path, case_id, alert_identifier, description=None, is_favorite=False)

Cette fonction ajoute une entrée au mur de la demande avec une pièce jointe (qui peut ensuite être téléchargée depuis le client sur l'ordinateur local de l'utilisateur). Cette fonction fait essentiellement la même chose que l'ajout d'éléments de preuve (en bas de l'écran de présentation de la demande).

Remarque : Pour importer un fichier dans le flux de la demande, assurez-vous qu'il est disponible dans le système de fichiers du serveur ou dans un emplacement partagé accessible depuis le serveur.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
file_path	{string}	Chemin d'accès au fichier	Tout chemin accessible	Un chemin d'accès peut également être un emplacement distant. Vous devez disposer d'autorisations de lecture pour ce fichier
case_id	{string}	Identifiant de la demande	Un numéro de demande pour ajouter la pièce jointe à son mur des demandes	La valeur par défaut est la demande actuelle.
alert_identifier	{string}	Identifiant de l'alerte	Chaîne d'identifiant de l'alerte à laquelle vous souhaitez associer la pièce jointe	La valeur par défaut est l'alerte en cours d'exécution.
description	{string}	Description de la pièce jointe	N'importe quelle chaîne	Aucune par défaut. Paramètre facultatif.
is_favorite	{boolean}	Favori de l'accessoire	Vrai/Faux	False par défaut. Paramètre facultatif.

Renvoie

{long} attachment_id

Exemple

from SiemplifyAction import SiemplifyAction
siemplify = SiemplifyAction()
siemplify.add_attachment(r'C:/temp/investigation.txt', description='Deep investigation report by TIER3 team', is_favorite=True)

Comportement du résultat

Dans cet exemple, nous allons importer le fichier investigation.txt depuis C:/temp sur la machine locale (le serveur lui-même) vers le mur de la demande. Un commentaire sera ajouté à cette entrée sur le mur de la demande, avec la chaîne dans la description. L'option is_favorite a été définie sur True. Cette nouvelle entrée sera donc également marquée d'une étoile (favori).

add_comment

add_comment(comment, case_id, alert_identifier)

Ajoutez un commentaire à la demande spécifique.

Remarque : Concepts associés : Manipulation de la casse

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
commentaire	{string}	Commentaire à ajouter à un mur de cas	"Les événements de cette alerte semblent suspects"	Commentaires liés à la demande
case_id	{string}	Identifiant de la demande	234	ND
alert_identifier	{string}	Identifiant de l'alerte	ad6879f1-b72d-419f-990c-011a2526b16d	ND

Renvoie

NoneType

Exemple

from SiemplifyAction import SiemplifyAction
siemplify = SiemplifyAction()
add_comment = "This alert is important"
alert_identifier = "ad6879f1-b72d-419f-990c-011a2526b16d"
case_id = "234"
siemplify.add_comment(comment, case_id, alert_identifier)

Comportement des résultats

Le commentaire fourni est ajouté au cas 234.

Result value

Aucun

add_entities_to_custom_list

add_entities_to_custom_list(custom_list_items)

Ajoutez la liste personnalisée fournie avec les entités ajoutées à la liste personnalisée.

Remarque : Concepts associés : Listes personnalisées

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
custom_list_items	{string}	Liste d'éléments de liste personnalisée	N/A	N/A

Renvoie

{[CustomList]} une liste avec l'élément de liste personnalisé ajouté.

Comportement des résultats

L'entité est ajoutée à une catégorie de liste personnalisée.

Remarque : Vous pouvez ajouter plusieurs valeurs à partir de CustomList ou manipuler plusieurs listes avec le même appel.

add_entity_insight

add_entity_insight(domain_entity_info, message, case_id, alert_id)

Ajoutez un insight d'entité.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
domain_entity_info	{string}	Identifiant de l'entité	"192.0.2.1"	{DomainEntityInfo}
message	{string}	Message d'insight	Ceci est un exemple de DNS	N/A
case_id	{string}	Identifiant de cas à ajouter à un insight d'entité	234	N/A
alert_id	{string}	Identifiant d'alerte à ajouter à un insight d'entité	ad6879f1-b72d-419f-990c-011a2526b16d	N/A

Renvoie

{boolean} True en cas de réussite

Exemple

from SiemplifyAction import SiemplifyAction
siemplify = SiemplifyAction()
entity = "192.0.2.1"
alert_identifier = "ad6879f1-b72d-419f-990c-011a2526b16d"
case_id = "234"
siemplify.add_entity_insight(domain_entity_info=entity, message=message, case_id=case_id, alert_id=alert_identifier)

Comportement des résultats

Le message donné est ajouté en tant qu'insight à l'entité 192.0.2.1 de l'identifiant d'alerte donné dans la demande 234.

Result value

Vrai.

"False" si l'insight n'est pas ajouté.

add_entity_to_case

add_entity_to_case(case_id, alert_identifier, entity_identifier, entity_type, is_internal, is_suspicious, is_enriched, is_vulnerable, properties, environment)

Ajoutez l'entité à la demande.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
entity_identifier	{string}	Identifiant de l'entité	192.0.2.1, example.com	N/A
entity_type	{string}	Type d'entité de l'identifiant d'entité	"ADDRESS"	N/A
is_internal	{boolean}	N/A	Vrai/Faux	N/A
is_suspicious	{boolean}	N/A	Vrai/Faux
is_enriched	{boolean}	N/A	Vrai/Faux	"False" par défaut
is_vulnerable	{boolean}	N/A	Vrai/Faux	"False" par défaut
du bucket	{dict}	Propriété de l'entité	{"property":"value"}	N/A

Renvoie

NoneType

Exemple

from SiemplifyAction import SiemplifyAction
siemplify = SiemplifyAction()
case_id = "234"
alert_identifier = "ad6879f1-b72d-419f-990c-011a2526b16d"
entity = "192.0.2.1"
entity_type = "ADDRESS"
properties = {"property": "value"}
siemplify.add_entity_to_case(case_id=case_id,
                                          alert_identifier = alert_identifier,
                                          entity_identifier = entity,
                                          entity_type = entity_type,
                                          is_internal = True,
                                          is_suspicious = False,
                                          is_enriched = False,
                                          is_vulnerable = False,
                                          properties = properties,
                                          environment=None)

Comportement des résultats

L'entité contenant les informations fournies sera ajoutée à l'alerte donnée dans la demande 234.

Result value

Aucun

add_or_update_case_task

add_or_update_case_task(task)

Ajouter ou mettre à jour une tâche : mettre à jour s'il existe un ID de tâche, sinon ajouter (créer).

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
opération	{Task}	Objet de tâche à ajouter à la demande ou à mettre à jour	N/A	N/A

Renvoie

{int} : ID de la tâche nouvelle ou mise à jour.

add_tag

add_tag(tag, case_id, alert_identifier)

Ajouter un tag à une demande spécifique.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
tag	{string}	Tag à ajouter	N/A	N/A
case_id	{string}	Identifiant de la demande	234	N/A
alert_identifier	{string}	Identifiant de l'alerte	ad6879f1-b72d-419f-990c-011a2526b16d	N/A

any_entity_in_custom_list

any_entity_in_custom_list(custom_list_items)

Vérifiez s'il existe une entité de la liste donnée qui possède un enregistrement de liste personnalisée avec la catégorie donnée.

Remarque : Concepts associés : Listes personnalisées

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
custom_list_items	{[CustomList]}	Liste d'éléments de liste personnalisée pour lesquels rechercher des entités	N/A	N/A

Renvoie

{boolean} True si une entité est trouvée, False sinon.

Result value

Vrai ou faux

assign_case

assign_case(user, case_id, alert_identifier)

Cette fonction attribue la demande actuelle à l'utilisateur.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
utilisateur	{string}	Utilisateur/Rôle	Admin, @Tier1	N/A
case_id	{string}	Identifiant de la demande à attribuer à l'utilisateur	234	N/A
alert_identifier	{string}	Identifiant de l'alerte à attribuer à l'utilisateur	ad6879f1-b72d-419f-990c-011a2526b16d	Cette valeur est récupérée lors de l'exécution de l'action

Renvoie

NoneType

Comportement des résultats

La demande est attribuée à l'utilisateur spécifié.

Result value

Aucun

attach_workflow_to_case

attach_workflow_to_case(workflow_name, cyber_case_id, indicator_identifier)

Associez un playbook au cas.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
workflow_name	{string}	Nom du workflow	N/A	N/A
cyber_case_id	{string}	Identifiant de la demande	234	N/A
indicator_identifier	{string}	Identifiant de l'alerte	ad6879f1-b72d-419f-990c-011a2526b16d	N/A

Renvoie

Code d'état {string} de l'opération du serveur

Exemple

from SiemplifyAction import SiemplifyAction
siemplify = SiemplifyAction()
alert_identifier = "ad6879f1-b72d-419f-990c-011a2526b16d"
case_id = "234"
workflow_name = "Workflow 234"
siemplify.attach_workflow_to_case(workflow_name=workflow_name, cyber_case_id=case_id, indicator_identifier=alert_identifier)

Comportement des résultats

Le workflow 234 sera associé à la demande 234.

Result value

Aucun

batch_update_case_id_matches

batch_update_case_id_matches(case_id_matches)

Mise à jour groupée des demandes avec les numéros de demande externes appropriés.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
case_id_matches	{list}	Liste d'objets SyncCaseIdMatch

Renvoie

{list} Liste des numéros de demande qui ont bien été mis à jour.

change_case_priority

change_case_priority(priority, case_id, alert_identifier)

Modifier la priorité de la demande.

Remarque : Concepts associés : Manipulation de la casse

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
priorité	{int}	Priorité de la demande à modifier	40/60/80/100	Consultez ApiSyncCasePriorityEnum. Mappage des priorités : {"Low": 40, "Medium": 60, "High": 80, "Critical": 100}
case_id	{string}	Identifiant de la demande	234	N/A
alert_identifier	{string}	Identifiant de l'alerte	ad6879f1-b72d-419f-990c-011a2526b16d	N/A

Renvoie

NoneType

Exemple

from SiemplifyAction import SiemplifyAction
siemplify = SiemplifyAction()
priority = 40
alert_identifier = "ad6879f1-b72d-419f-990c-011a2526b16d"
case_id = "234"
siemplify.change_case_priority(priority=priority, case_id=case_id, alert_identifier=alert_identifier)

Comportement des résultats

La priorité de la demande 234 est remplacée par 40, ce qui correspond à "Faible".

Result value

Aucun

change_case_stage

change_case_stage(stage, case_id, alert_identifier)

Modifier l'étape de traitement du cas.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
étape	{string}	Étape actuelle de la demande.	Incident	N/A
case_id	{string}	Identifiant de la demande	N/A	N/A
alert_identifier	{string}	Identifiant de l'alerte	ad6879f1-b72d-419f-990c-011a2526b16d	N/A

check_marketplace_status

check_marketplace_status()

Vérifiez l'état de la place de marché.
Si aucune erreur ne se produit, la fonction renvoie none. Sinon, une exception est renvoyée.

Paramètres

N/A

Renvoie

Aucun

close_alert

close_alert(root_cause, comment, reason, case_id, alert_id)

Cette fonction ferme l'alerte actuelle. Cela revient à fermer manuellement l'alerte depuis la vue d'ensemble de la demande. La fonction nécessite le motif de la clôture, une cause et un commentaire, tout comme l'alerte de clôture de cas.
La fermeture d'une alerte ferme le nouveau cas qui ne contient qu'une seule alerte.

Remarque : Concepts associés : Manipulation de la casse

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
root_cause	{string}	Cause de la clôture du cas	N/A	N/A
commentaire	{string}	Un commentaire	N/A	N/A
reason	{ApiSyncAlertCloseReasonEnum}	N/A	N/A	Consultez SiemplifyDataModel.ApiSyncAlertCloseReasonEnum.
case_id	{string}	Identifiant de l'enquête contenant l'alerte	234	N/A
alert_id	{string}	Identifiant de l'alerte à fermer	ad6879f1-b72d-419f-990c-011a2526b16d	N/A

Renvoie

{dict} résultat de l'opération du serveur

close_case

close_case(root_cause, comment, reason, case_id, alert_identifier)

Clôturer une demande

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
root_cause	{string}	La cause de la clôture d'un cas	N/A	N/A
commentaire	{string}	Un commentaire	N/A	N/A
reason	{ApiSyncAlertCloseReasonEnum}	Motif de clôture du cas		Consultez SiemplifyDataModel.ApiSyncAlertCloseReasonEnum.
case_id	{string}	Identifiant de la demande	234	N/A
alert_id	{string}	Identifiant de l'alerte	ad6879f1-b72d-419f-990c-011a2526b16d	N/A

create_case

create_case(case_info)

Cette fonction crée une demande avec les alertes et les événements contenus dans le dictionnaire case_info.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
case_info	{CaseInfo}	Objet d'informations sur la demande	N/A	Voir SiemplifyConnectorsDataModel.CaseInfo

Renvoie

NoneType

Comportement des résultats

La demande est créée avec les données fournies.

Result value

Aucun

create_case_insight_internal

create_case_insight_internal(case_id, alert_identifier, triggered_by, title, content, entity_identifier, severity, insight_type, additional_data=None, additional_data_type=None, additional_data_title=None, original_requesting_user=None, entity_type=None)

Ajoutez un insight.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
case_id	{string}	Identifiant de la demande	234	N/A
alert_identifier	{string}	Identifiant de l'alerte	ad6879f1-b72d-419f-990c-011a2526b16d	N/A
triggered_by	{string}	Nom de l'intégration	N/A	N/A
titre	{string}	Titre de l'insight	N/A	N/A
contenu	{string}	Message d'insight	N/A	N/A
entity_identifier	{string}	Identifiant de l'entité	N/A	N/A
de gravité,	{int}	Identifiant de gravité	0 = info, 1 = avertissement, 2 = erreur	N/A
insight_type	{int}	Type de statistiques	0 = général, 1 = entité	N/A
additional_data	N/A	N/A	N/A	N/A
additional_data_type	N/A	N/A	N/A	N/A
additional_data_title	N/A	N/A	N/A	N/A
original_requesting_user	N/A	N/A	N/A	N/A
entity_type	{string}	Type d'entité	"ADDRESS"	N/A

Renvoie

{boolean} True en cas de réussite.

create_connector_package

create_connector_package(connector_package)

Créez un package de connecteur dans le système.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
connector_package	{string}	Package du connecteur au format JSON	N/A	N/A

dismiss_alert

dismiss_alert(alert_group_identifier, should_close_case_if_all_alerts_were_dismissed, case_id)

Obsolète : la fonction est obsolète.

end

end(message, result_value, execution_state=0)

Terminez le script.
Aucun autre code n'est exécuté après la fonction end().
La valeur du résultat final est écrite dans stdout.
La fonction de fin n'est pas obligatoire pour les jobs planifiés.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
message	{string}	Message de sortie à afficher pour le client	Action terminée	N/A
result_value	{int/string/dict}	Valeur renvoyée	N/A	N/A
execution_state	{int}	Indicateur de l'état de l'action actuelle. Principalement utilisé dans les actions asynchrones pour indiquer si l'action est terminée ou non.	0 (EXECUTION_STATE_COMPLETED), 1 (EXECUTION_STATE_INPROGRESS), 2 (EXECUTION_STATE_FAILED), 3 (EXECUTION_STATE_TIMEDOUT)	La valeur par défaut est "0".

Renvoie

Renvoi des données de résultat au processus hôte.

Important : Si la fonction de fin n'est pas appelée, le script affiche l'erreur suivante : Script did not return expected data. Did you call build_result/end_script? Check DebugOutput for details.

end_script

end_script()

Obsolète : ne pas utiliser. Conservé pour assurer la rétrocompatibilité avec les anciens scripts.

escalate_case

escalate_case(comment, case_id, alert_identifier)

Escalader une demande.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
commentaire	{string}	Remonter le commentaire	N/A	N/A
case_id	{string}	Identifiant de la demande	234	N/A
alert_identifier	{string}	Identifiant de l'alerte	ad6879f1-b72d-419f-990c-011a2526b16d	N/A

extract_configuration_param

extract_configuration_param(provider_name, param_name, default_value=None, input_type=<class 'str'>, is_mandatory=False, print_value=False)

Récupérez un paramètre de configuration à partir de l'instance d'intégration.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
provider_name	{string}	Nom de l'intégration	N/A	N/A
param_name	{string}	Nom du paramètre	N/A	N/A
default_value	{any}	Si le paramètre n'est pas transmis, utilisez cette valeur par défaut	N/A	Aucun par défaut (facultatif)
input_type	{obj}	Convertissez le paramètre en un autre type	N/A	Par exemple, int. str par défaut (facultatif)
is_mandatory	{bool}	Générer une exception si le paramètre est vide	N/A	False par défaut (facultatif)
print_value	{bool}	Imprimer la valeur dans le journal	N/A	False par défaut (facultatif)

Renvoie

Valeur du paramètre (chaîne par défaut), sauf si input_type est spécifié.

static generate_serialized_object

generate_serialized_object(object_filter)

get_agent_by_id

get_agent_by_id(agent_id)

Récupère les détails de l'agent par ID.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
agent_id	{str}	ID de l'agent.	N/A	N/A

Renvoie

{dict} : informations sur l'éditeur

get_alerts_ticket_ids_from_cases_closed_since_timestamp

get_alerts_ticket_ids_from_cases_closed_since_timestamp(timestamp_unix_ms, rule_generator)

Récupère les alertes des demandes clôturées depuis le code temporel.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
timestamp_unix_ms	{long}	Horodatage	1550409785000L	N/A
rule_generator	{string}	N/A	'Détecteur d'e-mails d'hameçonnage'	N/A

Renvoie

{list} alertes

get_attachment

get_attachment(attachment_id)

Obtenez les données d'une pièce jointe par identifiant.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
attachment_id	{string}	Identifiant de la pièce jointe	N/A	N/A

Renvoie

Données de la pièce jointe {BytesIO}

get_attachments

get_attachments(case_id)

Obtenez les pièces jointes de la demande.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
case_id	{string}	Identifiant de la demande	234	N/A

Renvoie

{dict} pièces jointes

Result value

[{"is_favorite": False, "description": "", "type": ".txt", "id": 1, "name": "test.py"}]

_get_case_by_id

_get_case_by_id(case_id)

Récupérez une demande à l'aide de son numéro de demande.

Cette fonction interagit avec le point de terminaison suivant : external/v1/sdk/CaseFullDetails.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
case_id	{[string]}	Numéro de demande	N/A	N/A

Renvoie

{dict} données de cas.

get_case_closure_details

get_case_closure_details(case_id_list)

Obtenez des informations sur la clôture de la demande.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
case_id_list	{[string]}	Liste des numéros de demande	N/A	N/A

Renvoie

{[dict]} : liste de dictionnaires contenant les détails de la clôture de la demande.

Result value

[{'case_closed_action_type': 1, 'reason': NotMalicious', 'root_cause': 'Other'}]

Pour le paramètre case_closed_action_type, les valeurs possibles sont les suivantes :

• 0 = Automatique
• 1 = Manuel

get_case_comments

get_case_comments(case_id)

Cette fonction récupère les commentaires du cas fourni.

Remarque : Concepts associés : Manipulation de la casse

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
case_id	{string}	Identifiant de la demande	234	N/A

Renvoie

Liste

Exemple

from SiemplifyAction import SiemplifyAction
siemplify = SiemplifyAction()
siemplify.get_case_comments(case_id)

Comportement des résultats

Tous les commentaires appartenant à la demande seront récupérés.

Result value

[
    {
             u 'comment': u 'Test',
             u 'case_id': 10085,
             u 'is_favorite': False,
             u 'alert_identifier': None,
             u 'creator_user_id': u 'Admin',
             u 'type': 5,
             u 'id': 1,
             u 'modification_time_unix_time_in_ms': 1563272078332L
      }, {
             u 'comment': u 'jhfksdh',
             u 'case_id': 10085,
             u 'is_favorite': False,
             u 'alert_identifier': None,
             u 'creator_user_id': u 'Admin',
             u 'type': 5,
             u 'id': 2,
             u 'modification_time_unix_time_in_ms': 1563272079941L

       }, {
              u 'comment': u 'kjfhsdm',
              u 'case_id': 10085,
              u 'is_favorite': False,
              u 'alert_identifier': None,
              u 'creator_user_id': u 'Admin',
              u 'type': 5,
              u 'id': 3,
               u 'modification_time_unix_time_in_ms': 1563272080598L
       }
 ]

get_case_tasks

get_case_tasks(case_id)

Récupérez toutes les tâches par numéro de demande.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
case_id	{int/str}	Numéro de demande	234	La fonction peut recevoir un int ou un str

Renvoie

{[Task]} : liste des objets de tâche appartenant à la demande.
Consultez SiemplifyDataModel.Task.

get_cases_by_filter

get_cases_by_filter(environments=None, analysts=None, statuses=None, case_names=None, tags=None, priorities=None, stages=None, case_types=None, products=None, networks=None, ticked_ids_free_search='', case_ids_free_search='', wall_data_free_search='', entities_free_search='', start_time_unix_time_in_ms=-1, end_time_unix_time_in_ms=-1)

Obtenez les demandes en fonction des filtres demandés.

*caseFilterValue* object - { 'Title':'Merged Case', 'Value': 'Merged', 'Title':'Involved Suspicious Entity', 'Value': 'InvolvedSuspiciousEntity', 'Title':'Manual', 'Value': 'Manual', 'Title':'Simulated Alerts', 'Value': 'Simulated',}

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
environments	{[string]}	Liste des noms d'environnement (environment)	N/A	Si aucun environnement n'est fourni, None est utilisé (facultatif).
les analystes débutants	{[string]}	Liste des noms des analystes (utilisateur/rôle attribué à la demande)	N/A	Si aucun analyste n'est fourni, None est utilisé (facultatif).
statuts	{[int]}	Liste des états à utiliser comme critères de filtrage	N/A	Les valeurs statuses possibles sont : 1 = Open 2 = Closed Si aucun état n'est fourni, None est utilisé, ce qui renvoie les demandes ouvertes et fermées (facultatif).
case_names	{[string]}	Liste des noms de cas	N/A	Si aucun case_names n'est fourni, None est utilisé (facultatif).
tags	{[string]}	Liste des tags de cas	N/A	Si aucun tag n'est fourni, None est utilisé (facultatif).
priorités	{[int]}	Liste des priorités		Consultez ApiSyncAlertPriorityEnum. Si aucune priorité n'est fournie, None est utilisé (facultatif).
étapes	{list}	Liste des étapes (objet caseFilterValue)	N/A	Si aucune étape n'est fournie, None est utilisé (facultatif).
case_types	{list}	Liste des types d'objets (objet caseFilterValue)	N/A	Les valeurs case_types possibles sont : 0 = Merged 1 = Important 2 = InvolvedSuspiciousEntity 3 = Manual 4 = Simulated Si aucun case_types n'est fourni, None est utilisé (facultatif).
products	{list}	Liste de produits (objet caseFilterValue)	N/A	Si aucun produit n'est fourni, None est utilisé (facultatif).
réseaux	{list}	Liste des réseaux (objet caseFilterValue)	N/A	Si aucun réseau n'est fourni, None est utilisé (facultatif).
ticked_ids_free_search	{string}	Identifiant du ticket	N/A	Si aucune valeur n'est fournie, la valeur par défaut est "" (facultatif).
case_ids_free_search	{string}	Identifiant de la demande	N/A	Si aucune valeur n'est fournie, la valeur par défaut est "" (facultatif).
wall_data_free_search	{string}	Chaîne à rechercher	N/A	Si aucune valeur n'est fournie, la valeur par défaut est "" (facultatif).
entities_free_search	{string}	Identifiant de l'entité	N/A	Si aucune valeur n'est fournie, la valeur par défaut est "" (facultatif).
start_time_unix_time_in_ms	{long}	N/A	N/A	Valeur par défaut : -1 (facultatif)
end_time_unix_time_in_ms	{long}	N/A	N/A	Valeur par défaut : -1 (facultatif)

Renvoie

Case_ids ''

get_cases_by_ticket_id

get_cases_by_ticket_id(ticket_id)

Récupère une demande par identifiant de ticket.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
ticket_id	{string}	Identifiant du ticket	N/A	N/A

Renvoie

{[int]} liste de numéros de demande.

get_cases_ids_by_filter

get_cases_ids_by_filter(status, start_time_from_unix_time_in_ms=None, start_time_to_unix_time_in_ms=None, close_time_from_unix_time_in_ms=None, close_time_to_unix_time_in_ms=None, update_time_from_unix_time_in_ms=None, update_time_to_unix_time_in_ms=None, operator=None, sort_by='START_TIME', sort_order='DESC', max_results=1000)

Obtenez les numéros de demande par filtre.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
état	{str}	État de la demande à récupérer	'OPEN', 'CLOSE', 'BOTH'	N/A
start_time_from_unix_time_in_ms	{int}	Début de la plage de l'heure de début de la demande (inclus)	N/A	La valeur par défaut est de 30 jours avant (facultatif)
start_time_to_unix_time_in_ms	{int}	Heure de début de la demande (fin de la plage, incluse)	N/A	La valeur par défaut est l'heure actuelle (facultatif)
close_time_from_unix_time_in_ms	{int}	Début de la plage de dates de clôture de la demande (inclus)	N/A	La valeur par défaut est de 30 jours avant (facultatif)
close_time_to_unix_time_in_ms	{int}	Plage de fin de la date de clôture de la demande (incluse).	N/A	La valeur par défaut est l'heure actuelle (facultatif)
update_time_from_unix_time_in_ms	{int}	Début de la plage de dates et heures de modification du cas (inclus)	N/A	La valeur par défaut est l'heure de début (facultatif)
update_time_to_unix_time_in_ms	{int}	Date et heure de fin de la période de modification du cas (incluses)	N/A	La valeur par défaut est l'heure actuelle (facultatif)
opérateur	{str}	Opérateur pour les filtres temporels	OR, AND	Facultatif
sort_by	{str}	Trier les résultats par heure	START_TIME, UPDATE_TIME, CLOSE_TIME	Facultatif
sort_order	{str}	Ordre de tri	ASC, DESC	L'ordre par défaut est décroissant (facultatif)
max_results	{int}	Nombre maximal de résultats à renvoyer	N/A	La valeur par défaut est 1 000, et la valeur maximale est 10 000 (facultatif).

Remarque :

• L'ordre de tri de type CLOSE_TIME ne doit être fourni qu'avec l'état "CLOSE"
• Le filtre de période de fermeture est ignoré avec les états "BOTH" et "OPEN"

get_configuration

get_configuration(provider, environment, integration_instance)

Obtenir la configuration de l'intégration.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
fournisseur	{string}	Nom de l'intégration	"VirusTotal"	N/A
de test	{string}	Configuration pour un environnement spécifique ou "all" (tous)	N/A	N/A
integration_instance	{string}	Identifiant de l'instance d'intégration	N/A	N/A

Renvoie

Détails de la configuration {dict}.

get_configuration_by_provider

get_configuration_by_provider(identifier)

Obtenir la configuration de l'intégration.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
fournisseur	{string}	Nom de l'intégration	"VirusTotal"	N/A

Renvoie

Détails de la configuration {dict}

get_existing_custom_list_categories

get_existing_custom_list_categories()

Obtenez toutes les catégories de listes personnalisées existantes.
Cette fonction renvoie un objet de liste de toutes les catégories des paramètres CustomList, quel que soit l'environnement.

Paramètres

N/A

Renvoie

{[unicode]} : liste de types Unicode avec les catégories existantes.

Exemple

from SiemplifyAction import SiemplifyAction siemplify = SiemplifyAction() result = siemplify.get_existing_custom_list_categories()

Comportement des résultats

La liste de toutes les listes personnalisées existantes est renvoyée.

Result value

["DenyListed IPs", "AllowListed HOSTs"]

get_external_configuration

get_external_configuration(config_provider, config_name)

Récupérer la configuration de l'intégration externe.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
config_provider	{string}	N/A	N/A	N/A
config_name	{string}	N/A	N/A	N/A

get_integration_version

get_integration_version(integration_identifier)

Récupérez une version d'intégration.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
integration_identifier	{string}	Identifiant d'intégration	N/A	N/A

Renvoie

Version d'intégration {float}

get_publisher_by_id

get_publisher_by_id(publisher_id)

Obtenez les détails d'un éditeur par ID.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
publisher_id	{string}	ID de l'éditeur	N/A	N/A

Renvoie

{dict} : informations sur l'éditeur

get_remote_connector_keys_map

get_remote_connector_keys_map(publisher_id)

Obtenez les clés de chiffrement des connecteurs distants par référence éditeur.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
publisher_id	{string}	ID de l'éditeur	N/A	N/A

Renvoie

{dict} : mappage des clés

get_similar_cases

get_similar_cases(case_id, ports_filter, category_outcome_filter, rule_generator_filter, entity_identifiers_filter, start_time_unix_ms, end_time_unix_ms)

Obtenez des cas similaires.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
case_id	{string}	Identifiant de la demande	234	N/A
ports_filter	{boolean}	Vrai/Faux : utiliser un filtre de port	Vrai/Faux	N/A
category_outcome_filter	{boolean}	Vrai/Faux : utiliser le filtre category_outcome	Vrai/Faux	N/A
rule_generator_filter	{boolean}	Vrai/Faux : utiliser le filtre rule_generator	Vrai/Faux	N/A
entity_identifiers_filter	{boolean}	Vrai/Faux : utiliser le filtre entity_identifiers	Vrai/Faux	N/A
start_time_unix_ms	N/A	N/A	N/A	N/A
end_time_unix_ms	N/A	N/A	N/A	N/A

Renvoie

{dict}

get_sync_alerts

get_sync_alerts(alert_group_ids)

Récupérez les informations sur les alertes nécessaires à la synchronisation des systèmes.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
alert_group_ids	{list}	Liste des ID de groupes d'alertes à récupérer	N/A	N/A

Renvoie

{[SyncAlert]} liste d'objets SyncAlert.

get_sync_cases

get_sync_cases(case_ids)

Récupérez les informations sur la demande nécessaires à la synchronisation des systèmes.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
case_ids	{list}	Liste des numéros de demande à récupérer	N/A	N/A

Renvoie

{[SyncCase]} Liste d'objets SyncCase.

get_system_info

get_system_info(start_time_unixtime_ms)

get_system_version

get_system_version()

Obtenez la version actuelle de Google Security Operations SOAR.

Paramètres

N/A

Renvoie

{string} : version actuelle de Google Security Operations SOAR

get_temp_folder_path

get_temp_folder_path()

Récupère le chemin d'accès au dossier temporaire.

Paramètres

N/A

Renvoie

{string} chemin d'accès au dossier temporaire

get_ticket_ids_for_alerts_dismissed_since_timestamp

get_ticket_ids_for_alerts_dismissed_since_timestamp(timestamp_unix_ms)

Obsolète : la fonction est obsolète.

get_updated_sync_alerts_metadata

get_updated_sync_alerts_metadata(start_timestamp_unix_ms, count, allowed_environments=None, vendor=None)

Récupérez les métadonnées des alertes suivies mises à jour.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
start_timestamp_unix_ms	{long}	Rechercher les alertes mises à jour à partir du start_timestamp_unix_ms ou après	N/A	Si end_timestamp_unix_ms est None, l'heure de fin est l'heure de la requête.
nombre	{int}	Nombre maximal d'ID de groupes d'alertes à récupérer	N/A	N/A
allowed_environments	{[string]}	Environnements dans lesquels effectuer la recherche	N/A	Si allowed_environments est défini sur "None", recherchez dans tous les environnements
vendor	{string}	Filtrer les alertes par fournisseur	N/A	N/A

Renvoie

{[SyncAlertMetadata]} Liste d'objets SyncAlertMetadata, triés par SyncAlertMetadata.tracking_time.

get_updated_sync_cases_metadata

get_updated_sync_cases_metadata(start_timestamp_unix_ms, count, allowed_environments=None, vendor=None)

Récupérez les métadonnées mises à jour des demandes suivies.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
start_timestamp_unix_ms	{long}	Rechercher les demandes mises à jour à partir du start_timestamp_unix_ms ou après	N/A	Si end_timestamp_unix_ms est défini sur "None", l'heure de fin sera l'heure de la requête.
nombre	{int}	Nombre maximal de numéros de demande à récupérer	N/A	N/A
allowed_environments	{[string]}	Environnements dans lesquels effectuer la recherche	N/A	Si allowed_environments est défini sur "None", recherchez dans tous les environnements
vendor	{string}	Renvoyer uniquement les demandes avec des alertes provenant de vendor	N/A	N/A

Renvoie

{[SyncCaseMetadata]} Liste d'objets SyncCaseMetadata, triés par SyncCaseMetadata.tracking_time.

init_proxy_settings

init_proxy_settings()

Paramètres

N/A

is_existing_category

is_existing_category(category)

Vérifie si la catégorie donnée existe.
À partir d'un nom de catégorie, cette fonction renvoie True (booléen) si la chaîne exacte category name est définie comme catégorie dans les paramètres CustomList.
Cette fonction ignore l'environnement et renvoie True si l'élément existe, sinon elle renvoie False.

Remarque : Concepts associés : Listes personnalisées

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
catégorie	{string}	Catégorie dont l'existence doit être vérifiée	"Adresses IP sur liste de blocage"	N/A

Renvoie

{bool} "True" si la catégorie existe, "False" dans le cas contraire.

Exemple 1

from SiemplifyAction import SiemplifyAction
siemplify = SiemplifyAction()
result = siemplify.is_existing_category("WhiteListed HOSTs")

Exemple 2

from SiemplifyAction import SiemplifyAction
siemplify = SiemplifyAction()
result = siemplify.is_existing_category("SpecialHosts")

Comportement des résultats

Le résultat de l'exemple de code 1 renvoie True, et le résultat de l'exemple de code 2 renvoie False.

Result value

Vrai ou faux

mark_case_as_important

mark_case_as_important(case_id, alert_identifier)

Cette fonction marque comme important le cas actuel avec l'identifiant d'alerte donné.

Remarque : Concepts associés : Manipulation de la casse

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
case_id	{string}	Identifiant de la demande	234	N/A
alert_identifier	{string}	Identifiant de l'alerte	ad6879f1-b72d-419f-990c-011a2526b16d	N/A

Renvoie

NoneType

Exemple

from SiemplifyAction import SiemplifyAction
siemplify = SiemplifyAction()
alert_identifier = "ad6879f1-b72d-419f-990c-011a2526b16d"
case_id = "234"
siemplify.mark_case_as_important(case_id=case_id, alert_identifier=alert_identifier)

Comportement des résultats

La demande associée à l'identifiant d'alerte fourni est marquée comme importante.

Result value

Aucun

raise_incident

raise_incident(case_id, alert_identifier)

Cette fonction fait remonter la demande actuelle avec l'identifiant d'alerte en tant qu'incident.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
case_id	{string}	Identifiant de la demande	234	N/A
alert_identifier	{string}	Identifiant de l'alerte	ad6879f1-b72d-419f-990c-011a2526b16d	N/A

Renvoie

NoneType

Exemple

from SiemplifyAction import SiemplifyAction
siemplify = SiemplifyAction()
alert_identifier = "ad6879f1-b72d-419f-990c-011a2526b16d"
case_id = "234"
siemplify.raise_incident(case_id=case_id, alert_identifier=alert_identifier)

Comportement des résultats

La demande 234 sera signalée comme un incident.

Result value

Aucun

remove_entities_from_custom_list

remove_entities_from_custom_list(custom_list_items)

Supprimez les entités de la liste personnalisée avec la catégorie donnée.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
custom_list_items	{[CustomList]}	Liste d'éléments de liste personnalisée	N/A	N/A

Renvoie

Liste {[CustomList]} d'objets CustomList supprimés.

remove_temp_folder

remove_temp_folder()

Supprime le dossier temporaire et ses sous-dossiers.

Paramètres

N/A

property result

send_system_notification

send_system_notification(message, message_id='SDK_CUSTOM_NOTIFICATION')

Envoyer une notification système avec un ID de message facultatif.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
message	{string}	Message de la notification	N/A	N/A
message_id	{string}	Identifiant du message de notification	N/A	N/A

send_system_notification_message

send_system_notification_message(message, message_id)

Exemple

Comportement des résultats

Result value

set_alert_sla

set_alert_sla(period_time, period_type, critical_period_time, critical_period_type, case_id, alert_identifier)

Définit le SLA du alert_identifier de case_id donné. Le SLA défini à l'aide de cette API doit remplacer tous les autres types de SLA d'alerte.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
period_time	{int/str}	Représente la période totale du SLA	N/A	period_time > 0
period_type	{str}	Unités de temps de period_time, représentées par ApiPeriodTypeEnum	N/A	N/A
critical_period_time	{int/str}	Représente la période critique du SLA	N/A	critical_period_time >= 0 La période critique (après mise à l'échelle avec ses unités de temps) doit être inférieure à la période totale
critical_period_type	{str}	Unités de temps de critical_period_time, représentées par ApiPeriodTypeEnum	N/A	N/A
case_id	{long}	Identifiant de la demande	N/A	N/A
alert_identifier	{str}	Identifiant de l'alerte	N/A	N/A

set_case_sla

set_case_sla(period_time, period_type, critical_period_time, critical_period_type, case_id)

Définit le SLA du case_id donné. Le SLA défini à l'aide de cette API doit remplacer tous les autres types de SLA de demande.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
period_time	{int/string}	Représente la période totale du SLA	N/A	period_time > 0
period_type	{string}	Unités de temps de period_time, représentées par ApiPeriodTypeEnum	N/A	Non disponible
critical_period_time	{int/string}	Représente la période critique du SLA	N/A	critical_period_time >= 0 La période critique (après mise à l'échelle avec ses unités de temps) doit être inférieure à la période totale
critical_period_type	{string}	Unités de temps de critical_period_time, représentées par ApiPeriodTypeEnum	N/A	N/A
case_id	{long}	Identifiant de la demande	234	N/A

update_alerts_additional_data

update_alerts_additional_data(case_id, alerts_additional_data)

Mettez à jour les données supplémentaires des alertes.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
case_id	{string}	Identifiant de la demande	234	N/A
alerts_additional_data	{dict}	Toute donnée supplémentaire de l'alerte	N/A	N/A

update_entities

update_entities(updated_entities)

Cette fonction met à jour les entités.

Paramètres

Nom du paramètre	Type de paramètre	Définition	Valeurs possibles	Commentaires
updated_entities	{[{string:string}]}	N/A	N/A	N/A

Renvoie

NoneType

Comportement des résultats

À l'aide du champ d'application, l'alerte sélectionnée ajoute de nouvelles entités si elles ne sont pas déjà présentes.

Result value

Aucun