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

Compila un objeto de credenciales a partir de una cuenta de servicio, un correo electrónico de identidad para cargas de trabajo o atributos de la cuenta de servicio.

Nota Se debe proporcionar user_service_account, target_principal o service_account_attr (con **kwargs). De lo contrario, se generará una excepción EmptyMandatoryValues.

Parámetros

Parámetros
user_service_account SingleJson | None

Es el JSON de la cuenta de servicio del usuario.
target_principal str | None

Es el correo electrónico de la identidad para cargas de trabajo.
source_credentials google.auth.Credentials | None

Es la credencial de origen que se usó para adquirir las credenciales suplantadas.

Si se proporciona None, el sistema intentará usar las credenciales predeterminadas de la aplicación.
quota_project_id str | None

Es el ID del proyecto que se usa para la cuota y la facturación.
scopes list[str]

Son los permisos de las credenciales de Google Cloud . La configuración predeterminada es ['https://www.googleapis.com/auth/cloud-platform'].
verify_ssl bool

Define si se debe verificar el certificado SSL.

La configuración predeterminada es True.
service_account_attr dict[str, Any]

Pares clave-valor de los campos de la cuenta de servicio desestructurados.

Se genera el error

EmptyMandatoryValues: Se muestra cuando no hay una cuenta de servicio o un correo electrónico de identidad de cargas de trabajo, o si faltan campos obligatorios para la cuenta de servicio. google.auth.exceptions.RefreshError: Cuando no se pudieron actualizar las credenciales.

Devoluciones

Es un objeto de credenciales.

Tipo de datos que se muestra

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

Compila un objeto de credenciales a partir de los atributos de la cuenta de servicio.

Parámetros

Parámetros
account_type str

Es el tipo de cuenta de servicio.
project_id str

Es el ID del proyecto de la cuenta de servicio.
private_key_id str

Es el ID de la clave privada de la cuenta de servicio.
private_key str

Es la clave privada de la cuenta de servicio.
client_email str

Es el correo electrónico del cliente de la cuenta de servicio.
client_id str

Es el ID de cliente de la cuenta de servicio.
auth_uri str

Es el URI de autorización de la cuenta de servicio.
token_uri str

Es el URI del token de la cuenta de servicio.
auth_provider_x509_url str

Es la URL del certificado X509 del proveedor de autenticación de la cuenta de servicio.
client_x509_cert_url str

Es la URL del certificado x509 del cliente de la cuenta de servicio.
scopes list[str], optional

Son los permisos de las credenciales de Google Cloud . La configuración predeterminada es ['https://www.googleapis.com/auth/cloud-platform'].
quota_project_id str | None

Es el ID del proyecto que se usa para la cuota y la facturación.

Se genera el error

EmptyMandatoryValues: Se produce cuando faltan campos obligatorios para la cuenta de servicio.

Devoluciones

Es un objeto de credenciales.

Tipo de datos que se muestra

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 para acceder a los recursos de la API de Google Cloud con REST.

Parámetros

Parámetros
credentials google.oauth2.credentials.Credentials

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

Define si se debe actualizar el token de credenciales a través de SSL.

La configuración predeterminada es True.

Devoluciones

Es un token JWT que se usa en el encabezado de autorización.

Tipo de datos que se muestra

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 para acceder a los recursos de la API de Google Cloud con REST.

Parámetros
service_account str | dict

Google Cloud Cuenta de servicio del proyecto con las funciones necesarias de Identity and Access Management
expiry_length int

Es el tiempo establecido hasta que vence el token, en segundos. El valor predeterminado es 1 hora.
audience str

Google Cloud alcance. Si no se proporciona, se recurre a https://www.googleapis.com/auth/cloud-platform.

Devoluciones

Es un token JWT que se usa en el encabezado de autorización.

Tipo de datos que se muestra

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]

Obtiene las credenciales predeterminadas de la aplicación (ADC) del entorno de ejecución. Esta es una función de wrapper para google.auth.default.

Parámetros

Parámetros
scopes Sequence[str] | None

Es la lista de permisos de las credenciales.

Si se especifican, las credenciales se ajustan automáticamente cuando es necesario.
request google.auth.transport.Request | None

Es un objeto que se usa para realizar solicitudes HTTP. Se usa para detectar si la aplicación se ejecuta en Compute Engine o para determinar el ID del proyecto asociado a un recurso del grupo de identidades de carga de trabajo (credenciales de cuenta externa).

Si no se especifica, se usa el cliente HTTP de la biblioteca estándar para las credenciales de Compute Engine o un cliente de google.auth.transport.requests.Request para las credenciales de la cuenta externa.
quota_project_id str | None

Es el ID del proyecto que se usa para la cuota y la facturación.

Devoluciones

Son las credenciales y el ID del proyecto del entorno actual. El ID del proyecto puede ser None, lo que indica que no se pudo determinar el ID del proyecto a partir del entorno.

Tipo de datos que se muestra

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

Se genera el error

google.auth.exceptions.DefaultCredentialsError: Cuando no se encontraron credenciales o si las credenciales encontradas no eran válidas.

TIPCommon.rest.auth.get_auth_request

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

Crea una solicitud HTTP autorizada para una API de recursos de Google Cloud .

Parámetros

Parámetros
verify_ssl bool, optional

Verifica el certificado SSL. La configuración predeterminada es True.

Devoluciones

Es un objeto de solicitud autorizado.

Tipo de datos que se muestra

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

Obtiene un objeto Credentials de corta duración con la suplantación de identidad de la cuenta de servicio Google Cloud .

Parámetros

Parámetros
target_principal str

Cuenta de servicio cuya identidad se usará.
source_credentials google.auth.Credentials | None

Es la credencial de origen que se usó para adquirir las credenciales suplantadas.

Si no se proporciona nada, el sistema intentará usar las credenciales predeterminadas de la aplicación.
target_scopes Sequence[str] | None

Son los permisos que se solicitan durante el otorgamiento de la autorización.

Si se proporciona None, se usa el alcance predeterminado https://www.googleapis.com/auth/cloud-platform.
delegates Sequence[str] | None

Es la lista encadenada de delegados necesarios para otorgar el token de acceso final.

Si se configura, la secuencia de identidades debe tener la capacidad Service Account Token Creator otorgada a la identidad anterior.

Por ejemplo, si se configura como [serviceAccountB, serviceAccountC], el source_credential debe tener el rol de creador de tokens en serviceAccountB. serviceAccountB debe tener el rol de creador de tokens en serviceAccountC. Por último, C debe tener Token Creator en target_principal.

Si no se configura, source_credential debe tener ese rol en target_principal.
quota_project_id str | None

Es el ID del proyecto que se usa para la cuota y la facturación.

Nota: Este proyecto puede ser diferente del que se usó para crear las credenciales.

Devoluciones

Es un objeto Credentials de corta duración de la principal de destino.

Tipo de datos que se muestra

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

Obtiene las credenciales de cuenta de servicio de corta duración del arrendatario del SIEM de la instancia de Google SecOps.

Parámetros

Parámetros
chronicle_soar TIPCommon.types.ChronicleSOAR

Es el objeto del SDK de Google Security Operations SOAR.
target_scopes Sequence[str] | None

Son los permisos que se solicitan durante el otorgamiento de la autorización.
quota_project_id str | None

Es el ID del proyecto que se usa para la cuota y la facturación.

Nota: Este proyecto puede ser diferente del que se usó para crear las credenciales.

Devoluciones

Son las credenciales de cuenta de servicio de corta duración del arrendatario del SIEM.

Tipo de datos que se muestra

impersonated_credentials.Credentials

class TIPCommon.rest.gcp.GcpErrorReason

clase TIPCommon.rest.gcp.GcpErrorReason

Bases: object

Es el espacio de nombres de las constantes de Google Cloud Error Reason.

Constantes

  • IAM_PERMISSION_DENIED = 'IAM_PERMISSION_DENIED'

class TIPCommon.rest.gcp.GcpPermissions

clase TIPCommon.rest.gcp.GcpPermissions

Bases: object

Es el espacio de nombres de las constantes de Google Cloud Permissions.

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

Extrae el ID del proyecto del correo electrónico de la cuenta de servicio.

Parámetros

Parámetros
service_account_email str

Es el correo electrónico de la cuenta de servicio.

Devoluciones

El ID del proyecto.

Tipo de datos que se muestra

str

Se genera el error

NotFoundError: Cuando no se puede analizar el nombre del proyecto a partir del correo electrónico de la SA.

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

Extrae el ID del proyecto de la clave JSON de la cuenta de servicio.

Parámetros

Parámetros
service_account_json SingleJson

Es la clave JSON de la cuenta de servicio.

Devoluciones

Campo ID del proyecto de la clave de la cuenta de servicio.

Tipo de datos que se muestra

str

Se genera el error

NotFoundError: Cuando no se puede encontrar el campo "project_id" en la clave de la cuenta de servicio.

TIPCommon.rest.gcp.get_http_client

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

Obtiene un cliente HTTP autorizado Google Cloud .

Parámetros

Parámetros
credentials service_account.Credentials

Un objeto Credentials Google Cloud .
verify_ssl bool, opcional

Verifica el certificado SSL. La configuración predeterminada es True.

Devoluciones

Es el cliente HTTP autorizado.

Tipo de datos que se muestra

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 el correo electrónico de la cuenta de servicio de Workload Identity del servidor de metadatos Google Cloud .

Parámetros

Parámetros
default_sa_to_return str | None

Es la cuenta de servicio predeterminada que se devolverá si no se encuentra.

La configuración predeterminada es None.

Devoluciones

Es el correo electrónico de la cuenta de servicio de Workload.

Tipo de datos que se muestra

str

Se genera el error

GoogleCloudException: Cuando no se puede obtener el correo electrónico de la cuenta de servicio de GCP 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

Obtiene el ID del proyecto a partir de una cuenta de servicio o un correo electrónico de identidad para cargas de trabajo.

Parámetros

Parámetros
user_service_account SingleJson | None

Es el JSON de la cuenta de servicio del usuario.
service_account_email str | None

Es el correo electrónico de la identidad para cargas de trabajo.
default_project_id str | None

Es el ID del proyecto predeterminado que se devolverá si no se encuentra.

Si se proporciona, esta función no generará NotFoundError.

La configuración predeterminada es None.

Devoluciones

Es el ID del proyecto de la cuenta de servicio o el correo electrónico de la identidad de la carga de trabajo. Si no se encuentra, se muestra None.

Tipo de datos que se muestra

str | None

Se genera el error

NotFoundError: Cuando no se puede analizar el nombre del proyecto del correo electrónico de la SA.

TIPCommon.rest.gcp.validate_impersonation

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

Valida la suplantación de identidad de la cuenta de servicio a partir de una respuesta autorizada por HTTP.

Parámetros

Parámetros
content dict

Es el contenido de la respuesta autorizada de HTTP.
default_error_msg str, optional

Es un mensaje de error que se muestra si no se encuentra en el contenido de la respuesta.

La configuración predeterminada es "Service Account Impersonation failed".

Devoluciones

None si se autoriza la identidad temporal como cuenta de servicio

Tipo de datos que se muestra

None

Se genera el error

ImpersonationUnauthorizedError: Cuando no se autoriza el robo de identidad de la cuenta de servicio.

TIPCommon.rest.httplib.get_auth_session

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

Crea una sesión HTTP autorizada para una API de recursos de Google Cloud .

Parámetros
service_account str | dict

Una cuenta de servicio del proyecto Google Cloud con los roles de Identity and Access Management necesarios
audience str

Es el alcance de Google Cloud .
verify_ssl bool

Define si se creará una sesión con encriptación SSL.

Devoluciones

Es un objeto de sesión autorizado.

Tipo de datos que se muestra

requests.Session

Se genera el error

ValueError: Cuando no se proporcionan las credenciales ni la cuenta de servicio.

exception TIPCommon.rest.soar_api.SoarApiServerError

Bases: Exception

Son errores de las llamadas a la API del SOAR de Google Security Operations al servidor.

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]

Los lotes establecen valores de campos personalizados.

Parámetros

Parámetros
chronicle_soar Es un objeto del SDK de Google Security Operations SOAR.
identifier int

Es el identificador principal.
parent str

Es la ruta principal del valor del campo personalizado (p.ej., cases/1, cases/1/alerts/1).
custom_fields_values_mapping dict[int, list[str]]

Es la asignación de los IDs de campos personalizados a los valores.

Devoluciones

Es una lista de objetos CustomFieldValue.

Tipo de datos que se muestra

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]

Obtiene los eventos de una alerta específica.

Parámetros

Parámetros
chronicle_soar ChronicleSOAR

Es un objeto del SDK de Google Security Operations SOAR.
case_id str | int

Es el ID del caso. Ejemplo: 13, "41".
alert_identifier str

Es el identificador de la alerta (p.ej., '{alert.name}_{alert.id}').

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

Devoluciones

Es el JSON de la respuesta de la solicitud. Es una lista de objetos JSON de eventos.

Tipo de datos que se muestra

list[SingleJson]

Se genera el error

requests.HTTPError: Cuando el servidor devuelve un código de estado que no es de éxito. json.JSONDecodeError: Cuando el valor devuelto no es un JSON válido.

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]

Obtiene los archivos adjuntos del caso.

Parámetros

Parámetros
chronicle_soar ChronicleSOAR

Es un objeto del SDK de Google Security Operations SOAR.
case_id int

Es el ID del caso de Google Security Operations SOAR.

Devoluciones

Es una asignación mutable que representa los archivos adjuntos del caso.

Tipo de datos que se muestra

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

Obtén detalles generales del caso por ID.

Parámetros
chronicle_soar ChronicleSOAR

Es un objeto del SDK de Google Security Operations.
case_id int | str

Es el ID del caso de Google Security Operations SOAR.

Devoluciones

Es el objeto de detalles del caso.

Tipo de datos que se muestra

(CaseDetails)

Se genera el error

requests.HTTPError: Cuando falla una solicitud o el estado de la solicitud no es 200. json.JSONDecoderError: Se produce cuando falla el análisis de la respuesta.

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]

Obtiene todas las tarjetas de conector.

Parámetros

Parámetros
chronicle_soar ChronicleSOAR

Es un objeto del SDK de Google Security Operations SOAR.
integration_name str | None

Es el nombre de la integración.
connector_identifier str | None

Es el ID del conector.

Devoluciones

Es una lista de todas las tarjetas de conector.

Tipo de datos que se muestra

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 datos de la entidad.

Parámetros

Parámetros
chronicle_soar ChronicleSOAR

Es un objeto del SDK de Google Security Operations SOAR.
entity_identifier int

Es el identificador de la entidad.
entity_environment str

Es el entorno de la entidad.
entity_type str

Es el tipo de entidad.
last_case_type int

Es el último tipo de caso.
case_distribution_type int

Es el tipo de distribución del caso.

Devoluciones

Es una asignación mutable que representa los datos de la entidad.

Tipo de datos que se muestra

dict

Se genera el error

requests.HTTPError: Cuando el servidor devuelve un código de estado que no es de éxito.

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 una lista de archivos de definición de acciones del entorno.

Parámetros
chronicle_soar ChronicleSOAR

Es un objeto del SDK de Google SecOps.

Devoluciones

Es una lista de objetos SingleJson que representan los archivos de definición de la acción.

Tipo de datos que se muestra

(list[SingleJson])

Se genera el error

requests.HTTPError: Cuando el servidor devuelve un código de estado que no es de éxito. json.JSONDecodeError: Cuando el valor devuelto no es un JSON válido.

TIPCommon.rest.soar_api.get_federation_cases

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

Obtiene casos de federación.

Parámetros

Parámetros
chronicle_soar ChronicleSOAR

Es un objeto del SDK de Google Security Operations SOAR.

Devoluciones

Es la respuesta en formato JSON.

Tipo de datos que se muestra

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]

Obtiene los detalles completos del caso.

Parámetros

Parámetros
chronicle_soar ChronicleSOAR

Es un objeto del SDK de Google Security Operations SOAR.
case_id int

Es el ID del caso de Google Security Operations SOAR.

Devoluciones

Es una asignación mutable que representa los detalles completos del caso.

Tipo de datos que se muestra

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 todas las integraciones instaladas para los entornos proporcionados.

Parámetros

Parámetros
chronicle_soar ChronicleSOAR

Es un objeto del SDK de Google Security Operations SOAR.
environment str

Es la lista de entornos de la instancia.
integration_identifier str | None

Es el ID de la integración.

Devoluciones

Es una lista de objetos de diccionario que representan instancias de integración.

Tipo de datos que se muestra

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 una lista de archivos de definición de acciones del entorno.

Parámetros
chronicle_soar ChronicleSOAR

Es un objeto del SDK de Google SecOps.

Devoluciones

Es una lista de objetos SingleJson que representan los archivos de definición de la acción.

Tipo de datos que se muestra

(list[SingleJson])

Se genera el error

requests.HTTPError: Cuando el servidor devuelve un código de estado que no es de éxito. json.JSONDecodeError: Cuando el valor devuelto no es un JSON válido.

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 el archivo de detalles completo de la integración.

Parámetros
chronicle_soar ChronicleSOAR

Es un objeto del SDK de Google SecOps.
integration_identifier str

Es el ID de la integración.

Devoluciones

Es una respuesta JSON que contiene todos los detalles de la integración.

Tipo de datos que se muestra

(SingleJSON)

Se genera el error

requests.HTTPError: Cuando el servidor devuelve un código de estado que no es de éxito. json.JSONDecodeError: Cuando el valor devuelto no es un JSON válido.

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 tarjetas de perfil de usuario por página y filtro.

Parámetros

Parámetros
chronicle_soar ChronicleSOAR

Es un objeto del SDK de Google Security Operations SOAR.
search_term str

Son los términos de búsqueda.
requested_page int

Es el desplazamiento inicial para devolver la página de un usuario.
page_size int

Es la cantidad de usuarios que se devolverán.
filter_by_role bool

Define si se debe filtrar por rol.
filter_disabled_users bool

Define si se filtrarán los usuarios inhabilitados.
filter_support_users bool

Define si se deben filtrar los usuarios de asistencia.
fetch_only_support_users bool

Define si solo se deben devolver los usuarios de asistencia.
filter_permission_types list[int] | None

Es una lista de tipos de permisos de filtro (p.ej., 0).

Devoluciones

Es la respuesta del servidor de SOAR, es decir, la tarjeta de perfil del usuario.

Tipo de datos que se muestra

SingleJson

Se genera el error

requests.HTTPError: Cuando el servidor devuelve un código de estado que no es de éxito. json.JSONDecodeError: Cuando el valor devuelto no es un JSON válido.

Ejemplo

Ejemplo de la respuesta 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]

Obtiene una tarjeta de instancia de flujo de trabajo.

Parámetros

Parámetros
chronicle_soar ChronicleSOAR

Es un objeto del SDK de Google Security Operations SOAR.
case_id int

Es el ID del caso de Google Security Operations SOAR.
alert_identifier str

Es el ID de alerta de Google Security Operations SOAR.

Devoluciones

Es una asignación mutable que representa la tarjeta de instancia de flujo de trabajo.

Tipo de datos que se muestra

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]

Obtiene los valores de los campos personalizados para un caso o una alerta.

Parámetros

Parámetros
chronicle_soar ChronicleSOAR

Es un objeto del SDK de Google Security Operations SOAR.
parent str

Es la ruta principal del valor del campo personalizado (p.ej., cases/1, cases/1/alerts/1).

Devoluciones

Es el objeto de detalles del caso.

Tipo de datos que se muestra

list[CustomFieldValue]

Se genera el error

requests.HTTPError: Cuando falla la solicitud o el estado de la solicitud no es 200. json.JSONDecoderError: Se produce un error al analizar la respuesta.

TIPCommon.rest.soar_api.list_custom_fields

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

Enumera los campos personalizados.

Parámetros

Parámetros
chronicle_soar ChronicleSOAR

Es un objeto del SDK de Google Security Operations SOAR.
filter_ str | None

Es el valor del filtro para la búsqueda.

Devoluciones

Es el objeto de detalles del caso.

Tipo de datos que se muestra

list[CustomField]

Se genera el error

requests.HTTPError: Cuando falla la solicitud o el estado de la solicitud no es 200. json.JSONDecoderError: Se produce un error al analizar la respuesta.

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

Quita una etiqueta de caso.

Parámetros

Parámetros
chronicle_soar ChronicleSOAR

Es un objeto del SDK de Google Security Operations SOAR.
case_id int

Es el ID del caso de Google Security Operations SOAR.
tag str

Es una etiqueta que se quitará.
alert_identifier str | None

ID de la alerta de {The {google_secops_soar_name}}.

Devoluciones

Ninguno

Tipo de datos que se muestra

None

Se genera el error

requests.HTTPError: Cuando el servidor devuelve un código de estado que no es de éxito.

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]

Guarda un archivo directamente en la pared de la carcasa.

Parámetros

Parámetros
chronicle_soar ChronicleSOAR

Es un objeto del SDK de Google Security Operations SOAR.
attachment_data CaseWallAttachment

Un objeto CaseWallAttachment.

Devoluciones

Es una asignación mutable que representa la respuesta de la API.

Tipo de datos que se muestra

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

Establece la prioridad de la alerta.

Parámetros

Parámetros
chronicle_soar ChronicleSOAR

Es un objeto del SDK de Google Security Operations SOAR.
case_id int

Es el ID del caso de Google Security Operations SOAR.
alert_identifier str

Es el ID de alerta de Google Security Operations SOAR.
alert_name str

Es el nombre de la alerta de Google Security Operations SOAR.
priority int

Es el valor de enumeración de prioridad de Google Security Operations SOAR.

Devoluciones

Ninguno

Tipo de datos que se muestra

None

Se genera el error

requests.HTTPError: Cuando el servidor devuelve un código de estado que no es de éxito.

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]

Establece las puntuaciones de casos de forma masiva.

Parámetros

Parámetros
chronicle_soar ChronicleSOAR

Es un objeto del SDK de Google Security Operations SOAR.
case_score_mapping list[dict[str, int | float]]

Es un ID de caso de Google Security Operations SOAR para la asignación de puntuación.

Devoluciones

Es un JSON de respuesta que contiene el estado de éxito y, si corresponde, listas de casos fallidos.

Tipo de datos que se muestra

MutableMapping[str, Any]

Se genera el error

requests.HTTPError: Cuando el servidor devuelve un código de estado que no es de éxito.

Ejemplo

{
  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

Establece valores de campos personalizados.

Parámetros

Parámetros
chronicle_soar ChronicleSOAR

Es un objeto del SDK de Google Security Operations SOAR.
parent str

Es la ruta principal del valor del campo personalizado, p.ej.: cases/1, cases/1/alerts/1.
custom_field_id int

Es el ID del campo personalizado.
values list[str]

Es una lista de valores de campos personalizados que se deben establecer.

Devoluciones

Es un objeto CustomFieldValue.

Tipo de datos que se muestra

CustomFieldValue

TIPCommon.rest.soar_api.validate_response

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

Valida la respuesta y la devuelve como JSON.

Parámetros
response requests.Response

Es la respuesta que se validará.

Se genera el error

HTTPError: Cuando el código de estado de la respuesta indica una falla.

¿Necesitas más ayuda? Obtén respuestas de miembros de la comunidad y profesionales de Google SecOps.