Esta página se ha traducido con Cloud Translation API.

Módulo soar_ops

TIPCommon.soar_ops.create_slo_message

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

Recibe mensajes de advertencia de SLO en función de los intervalos de tiempo y los comentarios.

En el caso del parámetro interval_days=[0, 1, 7, 14], la función envía un mensaje en el que se advierte de que se incumplirá el SLO según la siguiente programación:

Entre 7 y 14 días antes de la hora de vencimiento.
De 1 a 7 días antes de la hora de vencimiento.
Cuándo se incumplió el SLO.

Si ya se ha enviado un comentario en el intervalo de infracción actual, no se devuelve ningún comentario nuevo (se devuelve None).

Parámetros
`slo`	`int` Fecha de incumplimiento del SLO en microsegundos de Unix (por ejemplo, 1_673_774_674_567)
`interval_days`	`Iterable[int]` Un iterable que contenga el número de días a partir de los cuales se deben enviar las advertencias de incumplimiento de tiempo (por ejemplo, [0, 1, 3, 7, 14]).
`existing_comments`	`Iterable[int]` Los comentarios que ya existen para comprobar si se ha enviado un comentario.

Aumentos

ValueError: cuando uno de los intervalos de tiempo es negativo.

Devoluciones

El comentario se devuelve si procede. De lo contrario, se devuelve None.

TIPCommon.soar_ops.get_clean_comment_body

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

Quita un prefijo de la cadena de comentario o del objeto de comentario.

Parámetros
`comment`	`str \| CaseComment` La cadena de comentario o el objeto de comentario del que se va a quitar el prefijo.
`prefix`	`str` Prefijo que se va a quitar.

Aumentos

TypeError- Cuando el tipo de comentario no es str ni CaseComment.

Devoluciones

El comentario sin el prefijo.

Tipo de devolución

str

TIPCommon.soar_ops.get_file

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

Devuelve el contenido del archivo en bytes.

Parámetros

Parámetros
`chronicle_soar`	`ChronicleSOAR` Objeto del SDK de Google Security Operations SOAR.
`identifier`	`str` El identificador del nombre de archivo junto con la ruta completa.

Devoluciones

Datos de bytes del identificador proporcionado.

Tipo de devolución

bytes | None

TIPCommon.soar_ops.get_secops_mode

TIPCommon.soar_ops.get_secops_mode()→ str | None

Devuelve la variable de entorno SECOPS_MODE.

Devoluciones

La variable de entorno SECOPS_MODE.

Tipo de devolución

str | None

TIPCommon.soar_ops.get_soar_case_comments

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

Devuelve una lista de objetos de comentarios de un caso, usando su ID.

Parámetros
`chronicle_soar`	`SiemplifyAction \| SiemplifyJob` El objeto SDK.
`case_id`	`str \| int` ID del caso cuyos comentarios se obtienen.

Devoluciones

Lista de objetos de comentarios.

Tipo de devolución

list[base.action.CaseComment]

TIPCommon.soar_ops.get_user_by_id

TIPCommon.soar_ops.get_user_by_id(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, user_id: str)→ UserProfileCard | None

Obtiene un objeto UserProfileCard a partir de un ID de usuario.

Parámetros

Parámetros
`chronicle_soar`	`ChronicleSOAR` Objeto del SDK de Google Security Operations SOAR.
`user_id`	`str` El ID de usuario, por ejemplo, `f6dc053c-58bb-4da5-95bb-739be7d297a2`.

Devoluciones

El objeto de usuario si se encuentra; de lo contrario, None.

Tipo de devolución

UserProfileCard | None

TIPCommon.soar_ops.get_users_profile_cards_with_pagination

TIPCommon.soar_ops.get_users_profile_cards_with_pagination(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, search_term: str = '', page_size: int = 20, filter_by_role: bool = False, filter_disabled_users: bool = False, filter_support_users: bool = False, fetch_only_support_users: bool = False, filter_permission_types: list[int] | None = None)→ list[UserProfileCard]

Obtiene todas las tarjetas de perfil de usuario mediante paginación. El tamaño de la página es el límite del número de usuarios de cada iteración.

Parámetros

Parámetros
`chronicle_soar`	`ChronicleSOAR` Objeto del SDK de Google Security Operations SOAR.
`search_term`	`str` Los términos de búsqueda. El valor predeterminado es `''`.
`page_size`	`int` Número de usuarios que se van a devolver. El valor predeterminado es `20`.
`filter_by_role`	`bool` Define si quieres filtrar por rol. El valor predeterminado es `False`.
`filter_disabled_users`	`bool` Define si quieres filtrar a los usuarios inhabilitados. El valor predeterminado es `False`.
`filter_support_users`	`bool` Define si quieres filtrar a los usuarios de asistencia. El valor predeterminado es `False`.
`fetch_only_support_users`	`bool` Define si solo se deben devolver los usuarios de asistencia. El valor predeterminado es `False`.
`filter_permission_types`	`list[int] \| None` Lista de tipos de permisos de filtro (por ejemplo, `0`). El valor predeterminado es `None`.

Devoluciones

Una lista de todos los usuarios.

Tipo de devolución

list[UserProfileCard]

TIPCommon.soar_ops.is_slo_comment

TIPCommon.soar_ops.is_slo_comment(comment: str)

Comprueba si un comentario es un comentario de advertencia de SLO.

Un comentario de SLO es una advertencia de SLO ("El SLO se incumplirá en {int} días") o un mensaje de incumplimiento de SLO ("Se ha incumplido el SLO").

Parámetros
`comment`	`str` El comentario que se va a comprobar.

Devoluciones

True si el comentario es un comentario de SLO. De lo contrario, se devuelve False.

Tipo de devolución

bool

TIPCommon.soar_ops.remove_prefix_from_comments

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

Elimina un prefijo (si lo hay) de una lista de comentarios.

Parámetros
`comments`	`list[str]` Los comentarios de los que se va a eliminar el prefijo.
`prefix`	`str` Prefijo que se va a quitar.

Devoluciones

Una lista de todos los comentarios después de que se les haya quitado el prefijo

Tipo de devolución

list[str]

TIPCommon.soar_ops.save_file

TIPCommon.soar_ops.save_file(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, path: str, name: str, content: bytes)→ bytes | None

Guarda un archivo en un Google Cloud contenedor o en una ruta local.

Parámetros

Parámetros
`chronicle_soar`	`ChronicleSOAR` Objeto del SDK de Google Security Operations SOAR.
`path`	`str` Ruta de la carpeta en la que se deben guardar los archivos.
`name`	`str` El nombre del archivo que se va a guardar.
`content`	`bytes` El contenido del archivo en formato de bytes.

Devoluciones

Ruta de los archivos descargados.

Tipo de devolución

str | None

¿Necesitas más ayuda? Recibe respuestas de los miembros de la comunidad y de los profesionales de Google SecOps.