TIPCommon.rest

TIPCommon.rest.auth.build_credentials_from_sa

TIPCommon.rest.auth.build_credentials_from_sa(user_service_account: MutableMapping[str, Any] | None = None, target_principal: str | None = None, source_credentials: Credentials | None = None, quota_project_id: str | None = None, scopes: list[str] | None = None, verify_ssl: bool | None = True, **service_account_attr: Any)→ Credentials

Crée un objet d'identifiants à partir d'un compte de service, d'une adresse e-mail Workload Identity ou d'attributs de compte de service.

Remarque Vous devez fournir user_service_account, target_principal ou service_account_attr (en utilisant **kwargs). Sinon, une exception EmptyMandatoryValues sera générée.

Paramètres

Paramètres
user_service_account SingleJson | None

Fichier JSON du compte de service utilisateur.
target_principal str | None

Adresse e-mail de l'identité de charge de travail.
source_credentials google.auth.Credentials | None

Identifiant source utilisé pour acquérir les identifiants usurpés.

Si None est fourni, le système tente d'utiliser les identifiants par défaut de l'application.
quota_project_id str | None

ID du projet utilisé pour le quota et la facturation.
scopes list[str]

Champs d'application des identifiants Google Cloud . La valeur par défaut est ['https://www.googleapis.com/auth/cloud-platform'].
verify_ssl bool

Définissez si le certificat SSL doit être validé.

La valeur par défaut est True.
service_account_attr dict[str, Any]

Paires clé-valeur des champs de compte de service déstructurés.

Génère

EmptyMandatoryValues : lorsqu'il n'y a pas d'adresse e-mail de compte de service ou d'identité de charge de travail, ou si des champs obligatoires du compte de service sont manquants. google.auth.exceptions.RefreshError : lorsque les identifiants n'ont pas pu être actualisés.

Renvoie

Objet d'identifiants.

Type renvoyé

service_account.Credentials

TIPCommon.rest.auth.build_credentials_from_sa_attr

TIPCommon.rest.auth.build_credentials_from_sa_attr(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, scopes: list[str] | None = None, quota_project_id: str | None = None)→ Credentials

Crée un objet d'identifiants à partir des attributs du compte de service.

Paramètres

Paramètres
account_type str

Type de compte de service.
project_id str

ID du projet de compte de service.
private_key_id str

ID de la clé privée du compte de service.
private_key str

Clé privée du compte de service.
client_email str

Adresse e-mail du client du compte de service.
client_id str

ID client du compte de service.
auth_uri str

URI d'authentification du compte de service.
token_uri str

URI du jeton de compte de service.
auth_provider_x509_url str

URL du certificat x509 du fournisseur d'authentification du compte de service.
client_x509_cert_url str

URL du certificat x509 du client du compte de service.
scopes list[str], optional

Champs d'application des identifiants Google Cloud . La valeur par défaut est ['https://www.googleapis.com/auth/cloud-platform'].
quota_project_id str | None

ID du projet utilisé pour le quota et la facturation.

Génère

EmptyMandatoryValues : lorsque des champs obligatoires pour le compte de service sont manquants.

Renvoie

Objet d'identifiants.

Type renvoyé

service_account.Credentials

TIPCommon.rest.auth.generate_jwt_from_credentials

TIPCommon.rest.auth.generate_jwt_from_credentials(credentials: Credentials, verify_ssl: bool = True)→ bytes

Génère un jeton Web JSON pour accéder aux ressources de l'API Google Cloud à l'aide de REST.

Paramètres

Paramètres
credentials google.oauth2.credentials.Credentials

Un objet google.oauth2.credentials.Credentials.
verify_ssl bool

Définissez si le jeton d'identifiants doit être actualisé via SSL.

La valeur par défaut est True.

Renvoie

Jeton JWT à utiliser dans l'en-tête Authorization.

Type renvoyé

bytes

TIPCommon.rest.auth.generate_jwt_from_sa

TIPCommon.rest.auth.generate_jwt_from_sa(service_account, expiry_length=3600, audience=None)

Génère un jeton Web JSON pour accéder aux ressources de l'API Google Cloud à l'aide de REST.

Paramètres
service_account str | dict

Google Cloud Compte de service du projet avec les rôles Identity and Access Management nécessaires.
expiry_length int

Délai avant expiration du jeton, en secondes. La valeur par défaut est d'une heure.
audience str

Google Cloud . Si aucune valeur n'est fournie, la valeur par défaut est https://www.googleapis.com/auth/cloud-platform.

Renvoie

Jeton JWT à utiliser dans l'en-tête d'autorisation.

Type renvoyé

bytes

TIPCommon.rest.auth.get_adc

TIPCommon.rest.auth.get_adc(scopes: Sequence[str] | None = None, request: Request | None = None, quota_project_id: str | None = None)→ Tuple[Credentials, str | None]

Obtient les identifiants par défaut de l'application (ADC) de l'environnement d'exécution. Il s'agit d'une fonction wrapper pour google.auth.default.

Paramètres

Paramètres
scopes Sequence[str] | None

Liste des champs d'application pour les identifiants.

Si des identifiants sont spécifiés, ils sont automatiquement limités au champ d'application nécessaire.
request google.auth.transport.Request | None

Objet utilisé pour effectuer des requêtes HTTP. Il permet de détecter si l'application s'exécute sur Compute Engine ou de déterminer l'ID de projet associé à une ressource de pool d'identités de charge de travail (identifiants de compte externe).

Si aucun client n'est spécifié, il utilise le client HTTP de la bibliothèque standard pour les identifiants Compute Engine ou un client google.auth.transport.requests.Request pour les identifiants de compte externe.
quota_project_id str | None

ID du projet utilisé pour le quota et la facturation.

Renvoie

Identifiants et ID de projet de l'environnement actuel. L'ID du projet peut être None, ce qui indique qu'il n'a pas pu être déterminé à partir de l'environnement.

Type renvoyé

Tuple[google.auth.credentials.Credentials, str]

Génère

google.auth.exceptions.DefaultCredentialsError : lorsqu'aucun identifiant n'a été trouvé ou que les identifiants trouvés n'étaient pas valides.

TIPCommon.rest.auth.get_auth_request

TIPCommon.rest.auth.get_auth_request(verify_ssl: bool = True)→ Request

Crée une requête HTTP autorisée pour une API de ressources Google Cloud .

Paramètres

Paramètres
verify_ssl bool, optional

Vérifie le certificat SSL. La valeur par défaut est True.

Renvoie

Objet de requête autorisé.

Type renvoyé

google.auth.transport.requests.Request

TIPCommon.rest.auth.get_impersonated_credentials

TIPCommon.rest.auth.get_impersonated_credentials(target_principal: str, source_credentials: google.auth.Credentials | None = None, target_scopes: Sequence[str] | None = None, delegates: Sequence[str] | None = None, quota_project_id: str | None = None)→ impersonated_credentials.Credentials

Obtient un objet Credentials de courte durée à l'aide de l'emprunt d'identité d'un compte de service Google Cloud .

Paramètres

Paramètres
target_principal str

Compte de service dont l'identité doit être empruntée.
source_credentials google.auth.Credentials | None

Identifiant source utilisé pour acquérir les identifiants usurpés.

Si rien n'est fourni, le système tente d'utiliser les identifiants par défaut de l'application.
target_scopes Sequence[str] | None

Niveaux d'accès à demander lors de l'attribution de l'autorisation.

Si None est fourni, le champ d'application https://www.googleapis.com/auth/cloud-platform par défaut est utilisé.
delegates Sequence[str] | None

Liste chaînée des délégués requis pour accorder le jeton d'accès final.

Si elle est définie, la séquence d'identités doit disposer de la fonctionnalité Service Account Token Creator accordée à l'identité précédente.

Par exemple, si la valeur est définie sur [serviceAccountB, serviceAccountC], le source_credential doit disposer du rôle de créateur de jetons sur serviceAccountB. serviceAccountB doit disposer du rôle de créateur de jetons sur serviceAccountC. Enfin, C doit disposer du créateur de jetons sur target_principal.

Si cette valeur n'est pas définie, source_credential doit disposer de ce rôle sur target_principal.
quota_project_id str | None

ID du projet utilisé pour le quota et la facturation.

Remarque : Ce projet peut être différent de celui utilisé pour créer les identifiants.

Renvoie

Objet Credentials de courte durée du compte principal cible.

Type renvoyé

impersonated_credentials.Credentials

TIPCommon.rest.auth.get_secops_siem_tenant_credentials

TIPCommon.rest.auth.get_secops_siem_tenant_credentials(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, target_scopes: Sequence[str] | None = None, quota_project_id: str | None = None)→ Credentials

Récupère les identifiants de compte de service éphémères du locataire SIEM de l'instance Google SecOps.

Paramètres

Paramètres
chronicle_soar TIPCommon.types.ChronicleSOAR

Objet SDK Google Security Operations SOAR.
target_scopes Sequence[str] | None

Niveaux d'accès à demander lors de l'attribution de l'autorisation.
quota_project_id str | None

ID du projet utilisé pour le quota et la facturation.

Remarque : Ce projet peut être différent de celui utilisé pour créer les identifiants.

Renvoie

Identifiants de compte de service éphémères du locataire SIEM.

Type renvoyé

impersonated_credentials.Credentials

class TIPCommon.rest.gcp.GcpErrorReason

class TIPCommon.rest.gcp.GcpErrorReason

Bases : objet

Espace de noms des constantes Google Cloud Error Reason.

Constantes

  • IAM_PERMISSION_DENIED = 'IAM_PERMISSION_DENIED'

class TIPCommon.rest.gcp.GcpPermissions

class TIPCommon.rest.gcp.GcpPermissions

Bases : objet

Espace de noms des constantes d'autorisations Google Cloud .

Constantes

  • IAM_SA_GET_ACCESS_TOKEN = 'iam.serviceAccounts.getAccessToken'

TIPCommon.rest.gcp.extract_project_id_from_sa_email

TIPCommon.rest.gcp.extract_project_id_from_sa_email(service_account_email: str)→ str

Extrait l'ID du projet à partir de l'adresse e-mail du compte de service.

Paramètres

Paramètres
service_account_email str

Adresse e-mail du compte de service.

Renvoie

ID du projet.

Type renvoyé

str

Génère

NotFoundError : lorsque le nom du projet ne peut pas être extrait de l'adresse e-mail du compte de service.

TIPCommon.rest.gcp.extract_project_id_from_sa_key

TIPCommon.rest.gcp.extract_project_id_from_sa_key(service_account_json: MutableMapping[str, Any])→ str

Extrait l'ID du projet à partir de la clé JSON du compte de service.

Paramètres

Paramètres
service_account_json SingleJson

Clé JSON du compte de service.

Renvoie

Champ "ID du projet" de la clé du compte de service.

Type renvoyé

str

Génère

NotFoundError : lorsque le champ "project_id" est introuvable dans la clé du compte de service.

TIPCommon.rest.gcp.get_http_client

TIPCommon.rest.gcp.get_http_client(credentials: Credentials, verify_ssl: bool = True)→ Http | AuthorizedHttp

Obtient un client HTTP autorisé Google Cloud .

Paramètres

Paramètres
credentials service_account.Credentials

Objet Credentials Google Cloud .
verify_ssl bool, facultatif

Vérifie le certificat SSL. La valeur par défaut est True.

Renvoie

Client HTTP autorisé.

Type renvoyé

Union[httplib2.Http, google_auth_httplib2.AuthorizedHttp]

TIPCommon.rest.gcp.get_workload_sa_email

TIPCommon.rest.gcp.get_workload_sa_email(default_sa_to_return: str | None = None)→ str

Récupère l'adresse e-mail du compte de service de charge de travail à partir du serveur de métadonnées Google Cloud .

Paramètres

Paramètres
default_sa_to_return str | None

Compte de service par défaut à renvoyer s'il est introuvable.

La valeur par défaut est None.

Renvoie

Adresse e-mail du compte de service Workload.

Type renvoyé

str

Génère

GoogleCloudException : lorsque l'adresse e-mail du compte de service GCP Workload ne peut pas être obtenue.

TIPCommon.rest.gcp.retrieve_project_id

TIPCommon.rest.gcp.retrieve_project_id(user_service_account: MutableMapping[str, Any] | None = None, service_account_email: str | None = None, default_project_id: str | None = None)→ str | None

Obtient l'ID de projet à partir d'une adresse e-mail de compte de service ou d'identité de charge de travail.

Paramètres

Paramètres
user_service_account SingleJson | None

Fichier JSON du compte de service utilisateur.
service_account_email str | None

Adresse e-mail de l'identité de charge de travail.
default_project_id str | None

ID de projet par défaut à renvoyer si aucun n'est trouvé.

Si elle est fournie, cette fonction ne générera pas NotFoundError.

La valeur par défaut est None.

Renvoie

ID de projet du compte de service ou de l'adresse e-mail Workload Identity. Si elle n'est pas trouvée, la fonction renvoie None.

Type renvoyé

str | None

Génère

NotFoundError : lorsque le nom du projet ne peut pas être analysé à partir de l'adresse e-mail du compte de service.

TIPCommon.rest.gcp.validate_impersonation

TIPCommon.rest.gcp.validate_impersonation(content: dict, default_error_msg: str = 'Service Account Impersonation failed')→ None

Valide l'emprunt d'identité d'un compte de service à partir d'une réponse HTTP autorisée.

Paramètres

Paramètres
content dict

Contenu de la réponse HTTP autorisée.
default_error_msg str, optional

Message d'erreur à générer si la valeur est introuvable dans le contenu de la réponse.

La valeur par défaut est "Service Account Impersonation failed".

Renvoie

None si l'emprunt d'identité de compte de service est autorisé.

Type renvoyé

None

Génère

ImpersonationUnauthorizedError : lorsque l'emprunt d'identité du compte de service n'est pas autorisé.

TIPCommon.rest.httplib.get_auth_session

TIPCommon.rest.httplib.get_auth_session(service_account, audience=None, verify_ssl=True)

Crée une session HTTP autorisée pour une API de ressources Google Cloud .

Paramètres
service_account str | dict

Un compte de service de projet Google Cloud avec les rôles Identity and Access Management nécessaires.
audience str

Champ d'application Google Cloud .
verify_ssl bool

Définit s'il faut créer une session avec chiffrement SSL.

Renvoie

Objet de session autorisé.

Type renvoyé

requests.Session

Génère

ValueError : lorsque les identifiants et le compte de service ne sont pas fournis.

exception TIPCommon.rest.soar_api.SoarApiServerError

Bases : Exception

Erreurs provenant des appels d'API de Google Security Operations SOAR au serveur.

TIPCommon.rest.soar_api.batch_set_custom_field_values

TIPCommon.rest.soar_api.batch_set_custom_field_values(chronicle_soar, identifier: int, parent: str, custom_fields_values_mapping: dict[int, list[str]])→ list[CustomFieldValue]

Définir des valeurs de champs personnalisés par lots.

Paramètres

Paramètres
chronicle_soar Objet SDK Google Security Operations SOAR.
identifier int

Identifiant parent.
parent str

Chemin parent de la valeur du champ personnalisé (par exemple, cases/1, cases/1/alerts/1).
custom_fields_values_mapping dict[int, list[str]]

Mappage des ID de champs personnalisés aux valeurs.

Renvoie

Liste d'objets CustomFieldValue.

Type renvoyé

list[CustomFieldValue]

TIPCommon.rest.soar_api.get_alert_events

TIPCommon.rest.soar_api.get_alert_events(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, case_id: str | int, alert_identifier: str)→ list[AlertEvent]

Récupère les événements d'une alerte spécifique.

Paramètres

Paramètres
chronicle_soar ChronicleSOAR

Objet SDK Google Security Operations SOAR.
case_id str | int

ID de la demande. Exemple : 13, "41".
alert_identifier str

Identifiant de l'alerte (par exemple, '{alert.name}_{alert.id}').

Exemple : alert.name=SERVICE_ACCOUNT_USED alert.id=c3b80f09-38d3-4328-bddb-b938ccee0256 identifier=SERVICE_ACCOUNT_USED_c3b80f09-38d3-4328-bddb-b938ccee0256.

Renvoie

JSON de la réponse à la requête. Liste des fichiers JSON des événements.

Type renvoyé

list[SingleJson]

Génère

requests.HTTPError : lorsque le serveur renvoie un code d'état autre que "succès". json.JSONDecodeError : lorsque la valeur renvoyée n'est pas un code JSON valide.

TIPCommon.rest.soar_api.get_case_attachments

TIPCommon.rest.soar_api.get_case_attachments(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, case_id: int)→ MutableMapping[str, Any]

Récupère les pièces jointes de la demande.

Paramètres

Paramètres
chronicle_soar ChronicleSOAR

Objet SDK Google Security Operations SOAR.
case_id int

ID de la demande Google Security Operations SOAR.

Renvoie

Mappage mutable représentant les pièces jointes de la demande.

Type renvoyé

MutableMapping[str, Any]

TIPCommon.rest.soar_api.get_case_overview_details

TIPCommon.rest.soar_api.get_case_overview_details(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, case_id: int | str) → CaseDetails

Obtenez des informations générales sur une demande à partir de son numéro.

Paramètres
chronicle_soar ChronicleSOAR

Objet SDK Google Security Operations.
case_id int | str

ID de la demande Google Security Operations SOAR.

Renvoie

Objet des détails de la demande.

Type renvoyé

(CaseDetails)

Génère

requests.HTTPError : lorsqu'une requête échoue ou que son état n'est pas 200. json.JSONDecoderError : lorsque l'analyse de la réponse échoue.

TIPCommon.rest.soar_api.get_connector_cards

TIPCommon.rest.soar_api.get_connector_cards(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, integration_name: str | None = None, connector_identifier: str | None = None)→ list[ConnectorCard]

Récupère toutes les cartes de connecteur.

Paramètres

Paramètres
chronicle_soar ChronicleSOAR

Objet SDK Google Security Operations SOAR.
integration_name str | None

Nom de l'intégration.
connector_identifier str | None

ID du connecteur.

Renvoie

Liste de toutes les cartes de connecteur.

Type renvoyé

list[ConnectorCard]

TIPCommon.rest.soar_api.get_entity_data

TIPCommon.rest.soar_api.get_entity_data(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, entity_identifier: str, entity_environment: str, entity_type: str | None = None, last_case_type: int = 0, case_distribution_type: int = 0)→ MutableMapping[str, Any]

Récupère les données d'entité.

Paramètres

Paramètres
chronicle_soar ChronicleSOAR

Objet SDK Google Security Operations SOAR.
entity_identifier int

Identifiant de l'entité.
entity_environment str

Environnement de l'entité.
entity_type str

Type de l'entité.
last_case_type int

Le dernier type de demande.
case_distribution_type int

Type de distribution de la demande.

Renvoie

Mappage mutable représentant les données de l'entité.

Type renvoyé

dict

Génère

requests.HTTPError : lorsque le serveur renvoie un code d'état autre que "succès".

TIPCommon.rest.soar_api.get_env_action_def_files

TIPCommon.rest.soar_api.get_env_action_def_files(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob)→ list[Dict[str, Any]]

Récupère une liste de fichiers de définition d'actions d'environnement.

Paramètres
chronicle_soar ChronicleSOAR

Objet du SDK Google SecOps.

Renvoie

Liste d'objets SingleJson représentant les fichiers de définition d'action.

Type renvoyé

(list[SingleJson])

Génère

requests.HTTPError : lorsque le serveur renvoie un code d'état autre que "réussite". json.JSONDecodeError : lorsque la valeur renvoyée n'est pas un code JSON valide.

TIPCommon.rest.soar_api.get_federation_cases

TIPCommon.rest.soar_api.get_federation_cases(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob)→ MutableMapping[str, Any]

Récupère les demandes de fédération.

Paramètres

Paramètres
chronicle_soar ChronicleSOAR

Objet SDK Google Security Operations SOAR.

Renvoie

Réponse JSON.

Type renvoyé

SingleJson

TIPCommon.rest.soar_api.get_full_case_details

TIPCommon.rest.soar_api.get_full_case_details(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, case_id: int)→ MutableMapping[str, Any]

Récupère tous les détails d'une demande.

Paramètres

Paramètres
chronicle_soar ChronicleSOAR

Objet SDK Google Security Operations SOAR.
case_id int

ID de la demande Google Security Operations SOAR.

Renvoie

Mappage mutable représentant tous les détails de la demande.

Type renvoyé

MutableMapping[str, Any]

TIPCommon.rest.soar_api.get_installed_integrations_of_environment

TIPCommon.rest.soar_api.get_installed_integrations_of_environment(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, environment: str, integration_identifier: str | None = None)→ list[InstalledIntegrationInstance]

Récupère toutes les intégrations installées pour les environnements fournis.

Paramètres

Paramètres
chronicle_soar ChronicleSOAR

Objet SDK Google Security Operations SOAR.
environment str

Liste des environnements d'instance.
integration_identifier str | None

ID de l'intégration.

Renvoie

Liste d'objets de dictionnaire représentant des instances d'intégration.

Type renvoyé

list[InstalledIntegrationInstance]

TIPCommon.rest.soar_api.get_installed_jobs

TIPCommon.rest.soar_api.get_installed_jobs(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob)→ list[Dict[str, Any]]

Récupère une liste de fichiers de définition d'actions d'environnement.

Paramètres
chronicle_soar ChronicleSOAR

Objet du SDK Google SecOps.

Renvoie

Liste d'objets SingleJson représentant les fichiers de définition d'action.

Type renvoyé

(list[SingleJson])

Génère

requests.HTTPError : lorsque le serveur renvoie un code d'état autre que "réussite". json.JSONDecodeError : lorsque la valeur renvoyée n'est pas un code JSON valide.

TIPCommon.rest.soar_api.get_integration_full_details

TIPCommon.rest.soar_api.get_integration_full_details(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, integration_identifier: str)→ Dict[str, Any]

Récupère le fichier de détails complet de l'intégration.

Paramètres
chronicle_soar ChronicleSOAR

Objet du SDK Google SecOps.
integration_identifier str

ID de l'intégration.

Renvoie

Réponse JSON contenant tous les détails de l'intégration.

Type renvoyé

(SingleJSON)

Génère

requests.HTTPError : lorsque le serveur renvoie un code d'état autre que "réussite". json.JSONDecodeError : lorsque la valeur renvoyée n'est pas un code JSON valide.

TIPCommon.rest.soar_api.get_user_profile_cards

TIPCommon.rest.soar_api.get_user_profile_cards(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, search_term: str = '', requested_page: int = 0, 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)→ MutableMapping[str, Any]

Récupère les fiches de profil utilisateur par page et par filtre.

Paramètres

Paramètres
chronicle_soar ChronicleSOAR

Objet SDK Google Security Operations SOAR.
search_term str

Termes de recherche.
requested_page int

Décalage de début pour renvoyer la page d'un utilisateur.
page_size int

Nombre d'utilisateurs à renvoyer.
filter_by_role bool

Définissez si vous souhaitez filtrer par rôle.
filter_disabled_users bool

Définissez si vous souhaitez filtrer les utilisateurs désactivés.
filter_support_users bool

Définissez si les utilisateurs de l'assistance doivent être filtrés.
fetch_only_support_users bool

Définissez si vous souhaitez renvoyer uniquement les utilisateurs de l'assistance.
filter_permission_types list[int] | None

Liste des types d'autorisations de filtre (par exemple, 0).

Renvoie

Réponse du serveur SOAR : fiche de profil de l'utilisateur.

Type renvoyé

SingleJson

Génère

requests.HTTPError : lorsque le serveur renvoie un code d'état autre que "succès". json.JSONDecodeError : lorsque la valeur renvoyée n'est pas un code JSON valide.

Exemple

Exemple de réponse JSON :

{
  "objectsList": [
    { "firstName": "string", "lastName": "string", "userName": "string", "accountState": 0 }
  ],
  "metadata": {
    "totalNumberOfPages": 0,
    "totalRecordsCount": 0,
    "pageSize": 0
  }
}

TIPCommon.rest.soar_api.get_workflow_instance_card

TIPCommon.rest.soar_api.get_workflow_instance_card(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, case_id: int, alert_identifier: str)→ MutableMapping[str, Any]

Récupère une fiche d'instance de workflow.

Paramètres

Paramètres
chronicle_soar ChronicleSOAR

Objet SDK Google Security Operations SOAR.
case_id int

ID de la demande Google Security Operations SOAR.
alert_identifier str

ID de l'alerte Google Security Operations SOAR.

Renvoie

Mappage mutable représentant la fiche d'instance de workflow.

Type renvoyé

MutableMapping[str, Any]

TIPCommon.rest.soar_api.list_custom_field_values

TIPCommon.rest.soar_api.list_custom_field_values(chronicle_soar, parent: str)→ list[CustomFieldValue]

Récupère les valeurs des champs personnalisés pour une demande ou une alerte.

Paramètres

Paramètres
chronicle_soar ChronicleSOAR

Objet SDK Google Security Operations SOAR.
parent str

Chemin d'accès parent de la valeur du champ personnalisé (par exemple, cases/1, cases/1/alerts/1).

Renvoie

Objet des détails de la demande.

Type renvoyé

list[CustomFieldValue]

Génère

requests.HTTPError : lorsque la requête échoue ou que son état n'est pas "200". json.JSONDecoderError : échec de l'analyse de la réponse.

TIPCommon.rest.soar_api.list_custom_fields

TIPCommon.rest.soar_api.list_custom_fields(chronicle_soar, filter_: str | None = None)→ list[CustomField]

Liste les champs personnalisés.

Paramètres

Paramètres
chronicle_soar ChronicleSOAR

Objet SDK Google Security Operations SOAR.
filter_ str | None

Valeur du filtre pour la recherche.

Renvoie

Objet des détails de la demande.

Type renvoyé

list[CustomField]

Génère

requests.HTTPError : lorsque la requête échoue ou que son état n'est pas "200". json.JSONDecoderError : échec de l'analyse de la réponse.

TIPCommon.rest.soar_api.remove_case_tag

TIPCommon.rest.soar_api.remove_case_tag(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, case_id: int, tag: str, alert_identifier: str | None = None)→ None

Supprime un tag de demande.

Paramètres

Paramètres
chronicle_soar ChronicleSOAR

Objet SDK Google Security Operations SOAR.
case_id int

ID de la demande Google Security Operations SOAR.
tag str

Tag à supprimer.
alert_identifier str | None

ID de l'alerte {google_secops_soar_name}.

Renvoie

Aucun

Type renvoyé

None

Génère

requests.HTTPError : lorsque le serveur renvoie un code d'état autre que "succès".

TIPCommon.rest.soar_api.save_attachment_to_case_wall

TIPCommon.rest.soar_api.save_attachment_to_case_wall(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, attachment_data: CaseWallAttachment)→ MutableMapping[str, Any]

Enregistre un fichier directement sur le mur de la demande.

Paramètres

Paramètres
chronicle_soar ChronicleSOAR

Objet SDK Google Security Operations SOAR.
attachment_data CaseWallAttachment

Un objet CaseWallAttachment.

Renvoie

Mappage mutable représentant la réponse de l'API.

Type renvoyé

MutableMapping[str, Any]

TIPCommon.rest.soar_api.set_alert_priority

TIPCommon.rest.soar_api.set_alert_priority(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, case_id: int, alert_identifier: str, alert_name: str, priority: int)→ None

Définit la priorité de l'alerte.

Paramètres

Paramètres
chronicle_soar ChronicleSOAR

Objet SDK Google Security Operations SOAR.
case_id int

ID de la demande Google Security Operations SOAR.
alert_identifier str

ID de l'alerte Google Security Operations SOAR.
alert_name str

Nom de l'alerte Google Security Operations SOAR.
priority int

Valeur enum de priorité Google Security Operations SOAR.

Renvoie

Aucun

Type renvoyé

None

Génère

requests.HTTPError : lorsque le serveur renvoie un code d'état autre que "succès".

TIPCommon.rest.soar_api.set_case_score_bulk

TIPCommon.rest.soar_api.set_case_score_bulk(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, case_score_mapping: list[dict[str, int | float]])→ MutableMapping[str, Any]

Définit les scores des demandes de manière groupée.

Paramètres

Paramètres
chronicle_soar ChronicleSOAR

Objet SDK Google Security Operations SOAR.
case_score_mapping list[dict[str, int | float]]

Mappage entre un numéro de demande Google Security Operations SOAR et un score.

Renvoie

Réponse JSON contenant l'état de réussite et, le cas échéant, les listes des cas ayant échoué.

Type renvoyé

MutableMapping[str, Any]

Génère

requests.HTTPError : lorsque le serveur renvoie un code d'état autre que "succès".

Exemple

{
  case_score_mapping = [
  {
    "caseId": 1, "score": 1.0
  }

]
}

TIPCommon.rest.soar_api.set_custom_field_values

TIPCommon.rest.soar_api.set_custom_field_values(chronicle_soar: ChronicleSOAR, parent: str, custom_field_id: int, values: list[str])→ CustomFieldValue

Définit les valeurs des champs personnalisés.

Paramètres

Paramètres
chronicle_soar ChronicleSOAR

Objet SDK Google Security Operations SOAR.
parent str

Chemin d'accès parent de la valeur du champ personnalisé, par exemple : cases/1, cases/1/alerts/1.
custom_field_id int

ID du champ personnalisé.
values list[str]

Liste des valeurs de champs personnalisés à définir.

Renvoie

Objet CustomFieldValue.

Type renvoyé

CustomFieldValue

TIPCommon.rest.soar_api.validate_response

TIPCommon.rest.soar_api.validate_response(response: Response, validate_json: bool = False) → None

Valide la réponse et la renvoie au format JSON.

Paramètres
response requests.Response

Réponse à valider.

Génère

HTTPError : lorsque le code d'état de la réponse indique un échec.

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