Questa pagina è stata tradotta dall'API Cloud Translation.

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

Crea un oggetto delle credenziali da un account di servizio, da un'email dell'identità del workload o dagli attributi del account di servizio.

Nota Devi fornire user_service_account, target_principal o service_account_attr (utilizzando **kwargs). In caso contrario, verrà generata un'eccezione EmptyMandatoryValues.

Parametri

Parametri
`user_service_account`	`SingleJson \| None` Il file JSON dell'account di servizio utente.
`target_principal`	`str \| None` L'email di Workload Identity.
`source_credentials`	`google.auth.Credentials \| None` Le credenziali di origine utilizzate per acquisire le credenziali di rappresentazione. Se viene fornito `None`, il sistema tenta di utilizzare le credenziali predefinite dell'applicazione.
`quota_project_id`	`str \| None` L'ID progetto utilizzato per la quota e la fatturazione.
`scopes`	`list[str]` Gli ambiti delle credenziali Google Cloud . Il valore predefinito è `['https://www.googleapis.com/auth/cloud-platform']`.
`verify_ssl`	`bool` Definisci se verificare il certificato SSL. Il valore predefinito è `True`.
`service_account_attr`	`dict[str, Any]` Coppie chiave-valore dei campi del account di servizio destrutturati.

Rialzi

EmptyMandatoryValues: quando non è presente un account di servizio o un'email dell'identità del workload oppure se mancano campi obbligatori per il account di servizio. google.auth.exceptions.RefreshError: quando non è stato possibile aggiornare le credenziali.

Restituisce

Un oggetto credenziali.

Tipo restituito

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

Crea un oggetto delle credenziali dagli attributi dell'account di servizio.

Parametri

Parametri
`account_type`	`str` Il tipo di account di servizio.
`project_id`	`str` L'ID progetto del account di servizio.
`private_key_id`	`str` L'ID della chiave privata del account di servizio.
`private_key`	`str` La chiave privata del account di servizio.
`client_email`	`str` L'email del client dell'account di servizio.
`client_id`	`str` L'ID client del account di servizio.
`auth_uri`	`str` L'URI di autenticazione dell'account di servizio.
`token_uri`	`str` L'URI del token del account di servizio.
`auth_provider_x509_url`	`str` L'URL del certificato x509 del fornitore di autenticazione dell'account di servizio.
`client_x509_cert_url`	`str` L'URL del certificato x509 client dell'account di servizio.
`scopes`	`list[str], optional` Gli ambiti delle credenziali Google Cloud . Il valore predefinito è `['https://www.googleapis.com/auth/cloud-platform']`.
`quota_project_id`	`str \| None` L'ID progetto utilizzato per la quota e la fatturazione.

Rialzi

EmptyMandatoryValues: quando mancano i campi obbligatori per il account di servizio.

Restituisce

Un oggetto credenziali.

Tipo restituito

service_account.Credentials

TIPCommon.rest.auth.generate_jwt_from_credentials

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

Genera un token web JSON per accedere alle risorse dell'API Google Cloud utilizzando REST.

Parametri

Parametri
`credentials`	`google.oauth2.credentials.Credentials` Un oggetto `google.oauth2.credentials.Credentials`.
`verify_ssl`	`bool` Definisci se aggiornare il token delle credenziali tramite SSL. Il valore predefinito è `True`.

credentials

google.oauth2.credentials.Credentials

Un oggetto google.oauth2.credentials.Credentials.

verify_ssl

bool

Definisci se aggiornare il token delle credenziali tramite SSL.

Il valore predefinito è True.

Restituisce

Un token JWT da utilizzare nell'intestazione Authorization.

Tipo restituito

bytes

TIPCommon.rest.auth.generate_jwt_from_sa

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

Genera un token web JSON per accedere alle risorse dell'API Google Cloud utilizzando REST.

Parametri
`service_account`	`str \| dict` Google Cloud service account di servizio con i ruoli Identity and Access Management necessari.
`expiry_length`	`int` Tempo impostato fino alla scadenza del token in secondi. Il valore predefinito è 1 ora.
`audience`	`str` Google Cloud ambito. Se non viene fornito, viene ripristinato il valore predefinito `https://www.googleapis.com/auth/cloud-platform`.

Restituisce

Un token JWT da utilizzare nell'intestazione di autorizzazione.

Tipo restituito

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]

Recupera le credenziali predefinite dell'applicazione (ADC) dell'ambiente di runtime. Questa è una funzione wrapper per google.auth.default.

Parametri

Parametri
`scopes`	`Sequence[str] \| None` L'elenco degli ambiti per le credenziali. Se specificate, le credenziali vengono automaticamente limitate all'ambito necessario.
`request`	`google.auth.transport.Request \| None` Un oggetto utilizzato per effettuare richieste HTTP. Viene utilizzato per rilevare se l'applicazione viene eseguita su Compute Engine o per determinare l'ID progetto associato per una risorsa del pool di identità del workload (credenziali dell'account esterno). Se non specificato, utilizza il client HTTP della libreria standard per le credenziali Compute Engine o un client `google.auth.transport.requests.Request` per le credenziali dell'account esterno.
`quota_project_id`	`str \| None` L'ID progetto utilizzato per la quota e la fatturazione.

scopes

Sequence[str] | None

L'elenco degli ambiti per le credenziali.

Se specificate, le credenziali vengono automaticamente limitate all'ambito necessario.

request

google.auth.transport.Request | None

Un oggetto utilizzato per effettuare richieste HTTP. Viene utilizzato per rilevare se l'applicazione viene eseguita su Compute Engine o per determinare l'ID progetto associato per una risorsa del pool di identità del workload (credenziali dell'account esterno).

Se non specificato, utilizza il client HTTP della libreria standard per le credenziali Compute Engine o un client google.auth.transport.requests.Request per le credenziali dell'account esterno.

quota_project_id

str | None

L'ID progetto utilizzato per la quota e la fatturazione.

Restituisce

Le credenziali e l'ID progetto dell'ambiente corrente. L'ID progetto potrebbe essere None, il che indica che non è stato possibile determinarlo dall'ambiente.

Tipo restituito

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

Rialzi

google.auth.exceptions.DefaultCredentialsError: quando non sono state trovate credenziali o se quelle trovate non erano valide.

TIPCommon.rest.auth.get_auth_request

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

Crea una richiesta HTTP autorizzata a un'API di risorse Google Cloud .

Parametri

Parametri
`verify_ssl`	`bool, optional` Verifica il certificato SSL. Il valore predefinito è `True`.

Restituisce

Un oggetto richiesta autorizzato.

Tipo restituito

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

Recupera un oggetto Credentials di breve durata utilizzando Google Cloud la rappresentazione dell'account di servizio.

Parametri

Parametri
`target_principal`	`str` Il account di servizio di cui simulare l'identità.
`source_credentials`	`google.auth.Credentials \| None` Le credenziali di origine utilizzate per acquisire le credenziali di rappresentazione. Se non viene fornito nulla, il sistema tenta di utilizzare le credenziali predefinite dell'applicazione.
`target_scopes`	`Sequence[str] \| None` Gli ambiti da richiedere durante la concessione dell'autorizzazione. Se viene fornito `None`, viene utilizzato l'ambito `https://www.googleapis.com/auth/cloud-platform` predefinito.
`delegates`	`Sequence[str] \| None` L'elenco concatenato dei delegati necessari per concedere il token di accesso finale. Se impostata, la sequenza di identità deve disporre della funzionalità `Service Account Token Creator` concessa all'identità precedente. Ad esempio, se impostato su `[serviceAccountB, serviceAccountC]`, `source_credential` deve disporre del ruolo di creatore di token su `serviceAccountB`. `serviceAccountB` deve avere Token Creator su `serviceAccountC`. Infine, `C` deve avere Token Creator su `target_principal`. Se non viene impostato, `source_credential` deve avere questo ruolo su `target_principal`.
`quota_project_id`	`str \| None` L'ID progetto utilizzato per la quota e la fatturazione. Nota: questo progetto potrebbe essere diverso da quello utilizzato per creare le credenziali.

Restituisce

Un oggetto credenziali di breve durata dell'entità di destinazione.

Tipo restituito

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

Recupera le credenziali del account di servizio di breve durata del tenant SIEM dell'istanza Google SecOps.

Parametri

Parametri
`chronicle_soar`	`TIPCommon.types.ChronicleSOAR` L'oggetto SDK di Google Security Operations SOAR.
`target_scopes`	`Sequence[str] \| None` Gli ambiti da richiedere durante la concessione dell'autorizzazione.
`quota_project_id`	`str \| None` L'ID progetto utilizzato per la quota e la fatturazione. Nota: questo progetto potrebbe essere diverso da quello utilizzato per creare le credenziali.

chronicle_soar

TIPCommon.types.ChronicleSOAR

L'oggetto SDK di Google Security Operations SOAR.

target_scopes

Sequence[str] | None

Gli ambiti da richiedere durante la concessione dell'autorizzazione.

quota_project_id

str | None

L'ID progetto utilizzato per la quota e la fatturazione.

Nota: questo progetto potrebbe essere diverso da quello utilizzato per creare le credenziali.

Restituisce

Credenziali di breve durata per l'account di servizio del tenant SIEM.

Tipo restituito

impersonated_credentials.Credentials

class TIPCommon.rest.gcp.GcpErrorReason

class TIPCommon.rest.gcp.GcpErrorReason

Base: object

Lo spazio dei nomi delle costanti Google Cloud Error Reason.

Costanti

IAM_PERMISSION_DENIED = 'IAM_PERMISSION_DENIED'

class TIPCommon.rest.gcp.GcpPermissions

class TIPCommon.rest.gcp.GcpPermissions

Base: object

Lo spazio dei nomi delle costanti Google Cloud Permissions.

Costanti

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

Estrae l'ID progetto dall'email del account di servizio.

Parametri

Parametri
`service_account_email`	`str` L'email del account di servizio.

Restituisce

L'ID progetto.

Tipo restituito

str

Rialzi

NotFoundError: quando non è possibile analizzare il nome del progetto dall'email dell'account di servizio.

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

Estrae l'ID progetto dalla chiave JSON del account di servizio.

Parametri

Parametri
`service_account_json`	`SingleJson` La chiave JSON del service account.

Restituisce

Campo ID progetto della chiave del account di servizio.

Tipo restituito

str

Rialzi

NotFoundError: quando non riesce a trovare il campo "project_id" nella chiave del service account.

TIPCommon.rest.gcp.get_http_client

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

Recupera un Google Cloud client HTTP autorizzato.

Parametri

Parametri
`credentials`	`service_account.Credentials` Un oggetto Google Cloud Credentials.
`verify_ssl`	`bool`, facoltativo Verifica il certificato SSL. Il valore predefinito è `True`.

Restituisce

Il client HTTP autorizzato.

Tipo restituito

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

Recupera l'email del account di servizio del workload dal server di metadati Google Cloud .

Parametri

Parametri
`default_sa_to_return`	`str \| None` Account di servizio predefinito da restituire se non viene trovato. Il valore predefinito è `None`.

default_sa_to_return

str | None

Account di servizio predefinito da restituire se non viene trovato.

Il valore predefinito è None.

Restituisce

L'indirizzo email del account di servizio Workload.

Tipo restituito

str

Rialzi

GoogleCloudException: quando non è possibile ottenere l'email del service account Google Cloud Workload.

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

Recupera l'ID progetto da un account di servizio o da un'email di identità del carico di lavoro.

Parametri

user_service_account

SingleJson | None

Il file JSON dell'account di servizio utente.

service_account_email

str | None

L'email di Workload Identity.

default_project_id

str | None

L'ID progetto predefinito da restituire se non viene trovato.

Se fornita, questa funzione non genererà NotFoundError.

Il valore predefinito è None.

Restituisce

L'ID progetto del account di servizio o dell'email dell'identità del carico di lavoro. Se non viene trovato, restituisce None.

Tipo restituito

str | None

Rialzi

NotFoundError: quando non è possibile analizzare il nome del progetto dall'email dell'account di servizio.

TIPCommon.rest.gcp.validate_impersonation

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

Convalida l'impersonificazione del service account da una risposta autorizzata HTTP.

Parametri

Parametri
`content`	`dict` Il contenuto della risposta HTTP autorizzata.
`default_error_msg`	`str, optional` Un messaggio di errore da generare se non viene trovato nei contenuti della risposta. Il valore predefinito è `"Service Account Impersonation failed"`.

content

dict

Il contenuto della risposta HTTP autorizzata.

default_error_msg

str, optional

Un messaggio di errore da generare se non viene trovato nei contenuti della risposta.

Il valore predefinito è "Service Account Impersonation failed".

Restituisce

None se l'impersonificazione del service account è autorizzata.

Tipo restituito

None

Rialzi

ImpersonationUnauthorizedError: quando la rappresentazione dell'identità del service account non è autorizzata.

TIPCommon.rest.httplib.get_auth_session

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

Crea una sessione HTTP autorizzata per un'API di risorse Google Cloud .

Parametri
`service_account`	`str \| dict` Un account di servizio del progetto con i ruoli Identity and Access Management necessari. Google Cloud
`audience`	`str` L'ambito Google Cloud .
`verify_ssl`	`bool` Definisce se creare una sessione con crittografia SSL.

Restituisce

Un oggetto di sessione autorizzato.

Tipo restituito

requests.Session

Rialzi

ValueError: quando non vengono fornite le credenziali e l'account di servizio.

exception TIPCommon.rest.soar_api.SoarApiServerError

Basi: Eccezione

Errori delle chiamate API di Google Security Operations SOAR al server.

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]

I batch impostano i valori dei campi personalizzati.

Parametri

Parametri
`chronicle_soar`	Un oggetto SDK di Google Security Operations SOAR.
`identifier`	`int` L'identificatore del genitore.
`parent`	`str` Il percorso principale per il valore del campo personalizzato (ad es. `cases/1`, `cases/1/alerts/1`).
`custom_fields_values_mapping`	`dict[int, list[str]]` Mappatura degli ID dei campi personalizzati ai valori.

Restituisce

Elenco di oggetti CustomFieldValue.

Tipo restituito

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]

Recupera gli eventi di un avviso specifico.

Parametri

chronicle_soar

ChronicleSOAR

Un oggetto SDK di Google Security Operations SOAR.

case_id

str | int

L'ID richiesta. Esempio: 13, "41".

alert_identifier

str

L'identificatore dell'avviso (ad es. '{alert.name}_{alert.id}').

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

Restituisce

Il JSON di risposta della richiesta. Un elenco dei file JSON degli eventi.

Tipo restituito

list[SingleJson]

Rialzi

requests.HTTPError: quando il server restituisce un codice di stato non riuscito. json.JSONDecodeError: quando il valore restituito non è un JSON valido.

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]

Recupera gli allegati della richiesta.

Parametri

Parametri
`chronicle_soar`	`ChronicleSOAR` Un oggetto SDK di Google Security Operations SOAR.
`case_id`	`int` L'case ID di Google Security Operations SOAR.

Restituisce

Un mapping modificabile che rappresenta gli allegati della richiesta.

Tipo restituito

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

Ottieni i dettagli della panoramica della richiesta in base all'case ID.

Parametri
`chronicle_soar`	`ChronicleSOAR` Un oggetto SDK di Google Security Operations.
`case_id`	`int \| str` L'case ID di Google Security Operations SOAR.

Restituisce

L'oggetto dei dettagli della richiesta.

Tipo restituito

(CaseDetails)

Rialzi

requests.HTTPError: quando una richiesta non va a buon fine o lo stato della richiesta non è 200. json.JSONDecoderError - When parsing the response fails.

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]

Recupera tutte le schede del connettore.

Parametri

Parametri
`chronicle_soar`	`ChronicleSOAR` Un oggetto SDK di Google Security Operations SOAR.
`integration_name`	`str \| None` Il nome dell'integrazione.
`connector_identifier`	`str \| None` L'ID connettore.

Restituisce

Un elenco di tutte le schede dei connettori.

Tipo restituito

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]

Recupera i dati dell'entità.

Parametri

Parametri
`chronicle_soar`	`ChronicleSOAR` Un oggetto SDK di Google Security Operations SOAR.
`entity_identifier`	`int` L'identificatore dell'entità.
`entity_environment`	`str` L'ambiente dell'entità.
`entity_type`	`str` Il tipo di entità.
`last_case_type`	`int` L'ultimo tipo di richiesta.
`case_distribution_type`	`int` Il tipo di distribuzione delle richieste.

Restituisce

Una mappatura modificabile che rappresenta i dati dell'entità.

Tipo restituito

dict

Rialzi

requests.HTTPError: quando il server restituisce un codice di stato non riuscito.

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

Recupera un elenco di file di definizione delle azioni dell'ambiente.

Parametri
`chronicle_soar`	`ChronicleSOAR` Un oggetto Google SecOps SDK.

Restituisce

Un elenco di oggetti SingleJson che rappresentano i file di definizione dell'azione.

Tipo restituito

(list[SingleJson])

Rialzi

requests.HTTPError: quando il server restituisce un codice di stato non riuscito. json.JSONDecodeError: quando il valore restituito non è un JSON valido.

TIPCommon.rest.soar_api.get_federation_cases

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

Recupera le richieste della federazione.

Parametri

Parametri
`chronicle_soar`	`ChronicleSOAR` Un oggetto SDK di Google Security Operations SOAR.

Restituisce

JSON della risposta.

Tipo restituito

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]

Visualizza i dettagli completi della richiesta.

Parametri

Parametri
`chronicle_soar`	`ChronicleSOAR` Un oggetto SDK di Google Security Operations SOAR.
`case_id`	`int` L'case ID di Google Security Operations SOAR.

Restituisce

Una mappatura modificabile che rappresenta i dettagli completi della richiesta.

Tipo restituito

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]

Recupera tutte le integrazioni installate per gli ambienti forniti.

Parametri

Parametri
`chronicle_soar`	`ChronicleSOAR` Un oggetto SDK di Google Security Operations SOAR.
`environment`	`str` L'elenco degli ambienti dell'istanza.
`integration_identifier`	`str \| None` L'ID integrazione.

Restituisce

Un elenco di oggetti dizionario che rappresentano le istanze di integrazione.

Tipo restituito

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

Recupera un elenco di file di definizione delle azioni dell'ambiente.

Parametri
`chronicle_soar`	`ChronicleSOAR` Un oggetto Google SecOps SDK.

Restituisce

Un elenco di oggetti SingleJson che rappresentano i file di definizione dell'azione.

Tipo restituito

(list[SingleJson])

Rialzi

requests.HTTPError: quando il server restituisce un codice di stato non riuscito. json.JSONDecodeError: quando il valore restituito non è un JSON valido.

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]

Recupera il file con i dettagli completi dell'integrazione.

Parametri
`chronicle_soar`	`ChronicleSOAR` Un oggetto Google SecOps SDK.
`integration_identifier`	`str` L'ID integrazione.

Restituisce

Una risposta JSON contenente tutti i dettagli dell'integrazione.

Tipo restituito

(SingleJSON)

Rialzi

requests.HTTPError: quando il server restituisce un codice di stato non riuscito. json.JSONDecodeError: quando il valore restituito non è un JSON valido.

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]

Recupera le schede del profilo utente per pagina e filtro.

Parametri

Parametri
`chronicle_soar`	`ChronicleSOAR` Un oggetto SDK di Google Security Operations SOAR.
`search_term`	`str` I termini di ricerca.
`requested_page`	`int` L'offset iniziale per restituire la pagina di un utente.
`page_size`	`int` Il numero di utenti da restituire.
`filter_by_role`	`bool` Definisci se filtrare in base al ruolo.
`filter_disabled_users`	`bool` Definisci se filtrare gli utenti disattivati.
`filter_support_users`	`bool` Definisci se filtrare gli utenti dell'assistenza.
`fetch_only_support_users`	`bool` Definisci se restituire solo gli utenti dell'assistenza.
`filter_permission_types`	`list[int] \| None` Un elenco di tipi di autorizzazione per i filtri (ad es. `0`).

Restituisce

La risposta del server SOAR: la scheda del profilo utente.

Tipo restituito

SingleJson

Rialzi

requests.HTTPError: quando il server restituisce un codice di stato non riuscito. json.JSONDecodeError: quando il valore restituito non è un JSON valido.

Esempio

Un esempio di JSON di risposta:

{
  "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]

Recupera una scheda dell'istanza del flusso di lavoro.

Parametri

Parametri
`chronicle_soar`	`ChronicleSOAR` Un oggetto SDK di Google Security Operations SOAR.
`case_id`	`int` L'case ID di Google Security Operations SOAR.
`alert_identifier`	`str` L'ID avviso di Google Security Operations SOAR.

Restituisce

Una mappatura modificabile che rappresenta la scheda dell'istanza del workflow.

Tipo restituito

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]

Recupera i valori dei campi personalizzati per un caso o un avviso.

Parametri

Parametri
`chronicle_soar`	`ChronicleSOAR` Un oggetto SDK di Google Security Operations SOAR.
`parent`	`str` Il percorso principale per il valore del campo personalizzato (ad es. `cases/1`, `cases/1/alerts/1`).

Restituisce

L'oggetto dei dettagli della richiesta.

Tipo restituito

list[CustomFieldValue]

Rialzi

requests.HTTPError: quando la richiesta non va a buon fine o lo stato della richiesta non è 200. json.JSONDecoderError: quando l'analisi della risposta non va a buon fine.

TIPCommon.rest.soar_api.list_custom_fields

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

Elenca i campi personalizzati.

Parametri

Parametri
`chronicle_soar`	`ChronicleSOAR` Un oggetto SDK di Google Security Operations SOAR.
`filter_`	`str \| None` Il valore del filtro per la ricerca.

Restituisce

L'oggetto dei dettagli della richiesta.

Tipo restituito

list[CustomField]

Rialzi

requests.HTTPError: quando la richiesta non va a buon fine o lo stato della richiesta non è 200. json.JSONDecoderError: quando l'analisi della risposta non va a buon fine.

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

Rimuove un tag della richiesta.

Parametri

Parametri
`chronicle_soar`	`ChronicleSOAR` Un oggetto SDK di Google Security Operations SOAR.
`case_id`	`int` L'case ID di Google Security Operations SOAR.
`tag`	`str` Un tag da rimuovere.
`alert_identifier`	`str \| None` ID avviso di {google_secops_soar_name}.

Restituisce

Nessuno.

Tipo restituito

None

Rialzi

requests.HTTPError: quando il server restituisce un codice di stato non riuscito.

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]

Salva un file direttamente nella bacheca della richiesta.

Parametri

Parametri
`chronicle_soar`	`ChronicleSOAR` Un oggetto SDK di Google Security Operations SOAR.
`attachment_data`	`CaseWallAttachment` Un oggetto `CaseWallAttachment`.

Restituisce

Una mappatura modificabile che rappresenta la risposta dell'API.

Tipo restituito

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

Imposta la priorità dell'avviso.

Parametri

Parametri
`chronicle_soar`	`ChronicleSOAR` Un oggetto SDK di Google Security Operations SOAR.
`case_id`	`int` L'case ID di Google Security Operations SOAR.
`alert_identifier`	`str` L'ID avviso di Google Security Operations SOAR.
`alert_name`	`str` Il nome dell'avviso Google Security Operations SOAR.
`priority`	`int` Il valore di enumerazione della priorità di Google Security Operations SOAR.

Restituisce

Nessuno.

Tipo restituito

None

Rialzi

requests.HTTPError: quando il server restituisce un codice di stato non riuscito.

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]

Imposta i punteggi dei casi in blocco.

Parametri

Parametri
`chronicle_soar`	`ChronicleSOAR` Un oggetto SDK di Google Security Operations SOAR.
`case_score_mapping`	`list[dict[str, int \| float]]` Una mappatura dell'case ID di Google Security Operations SOAR al punteggio.

Restituisce

Un JSON di risposta contenente lo stato di successo e, se applicabile, elenchi di casi non riusciti.

Tipo restituito

MutableMapping[str, Any]

Rialzi

requests.HTTPError: quando il server restituisce un codice di stato non riuscito.

Esempio

{
  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

Imposta i valori dei campi personalizzati.

Parametri

Parametri
`chronicle_soar`	`ChronicleSOAR` Un oggetto SDK di Google Security Operations SOAR.
`parent`	`str` Il percorso principale per il valore del campo personalizzato, ad esempio: `cases/1`, `cases/1/alerts/1`.
`custom_field_id`	`int` L'ID del campo personalizzato.
`values`	`list[str]` Un elenco di valori dei campi personalizzati da impostare.

Restituisce

Un oggetto CustomFieldValue.

Tipo restituito

CustomFieldValue

TIPCommon.rest.soar_api.validate_response

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

Convalida la risposta e la restituisce in formato JSON.

Parametri
`response`	`requests.Response` La risposta da convalidare.

Rialzi

HTTPError: quando il codice di stato della risposta indica un errore.

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