Se usó la API de Cloud Translation para traducir esta página.

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

Obtiene mensajes de advertencia del SLO según los intervalos de tiempo y los comentarios existentes.

Para el parámetro interval_days=[0, 1, 7, 14], la función envía un mensaje de advertencia que indica que se incumpliría 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 envió un comentario en el intervalo incumplido 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 contiene la cantidad 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]` Son los comentarios existentes para verificar si ya se envió un comentario.

Se genera el error

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

Devoluciones

Se devuelve el comentario si corresponde. 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 o el objeto de comentario.

Parámetros
`comment`	`str \| CaseComment` Es la cadena o el objeto de comentario del que se quitará el prefijo.
`prefix`	`str` Es el prefijo que se quitará.

Se genera el error

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

Devoluciones

Es el comentario sin el prefijo.

Tipo de datos que se muestra

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` Es un objeto del SDK de Google Security Operations SOAR.
`identifier`	`str` Es el identificador del nombre de archivo junto con la ruta completa.

Devoluciones

Son los datos en bytes del identificador proporcionado.

Tipo de datos que se muestra

bytes | None

TIPCommon.soar_ops.get_secops_mode

TIPCommon.soar_ops.get_secops_mode()→ str | None

Devuelve la variable de entorno SECOPS_MODE.

Devoluciones

Es la variable de entorno SECOPS_MODE.

Tipo de datos que se muestra

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` Objeto del SDK.
`case_id`	`str \| int` ID del caso cuyos comentarios se recuperan.

Devoluciones

Es una lista de objetos de comentarios.

Tipo de datos que se muestra

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` Es un objeto del SDK de Google Security Operations SOAR.
`user_id`	`str` Es el ID de usuario, p.ej., `f6dc053c-58bb-4da5-95bb-739be7d297a2`.

Devoluciones

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

Tipo de datos que se muestra

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 del usuario con paginación. El tamaño de la página sirve como límite para la cantidad de usuarios en cada iteración.

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. La configuración predeterminada es `''`.
`page_size`	`int` Es la cantidad de usuarios que se devolverán. La configuración predeterminada es `20`.
`filter_by_role`	`bool` Define si se debe filtrar por rol. La configuración predeterminada es `False`.
`filter_disabled_users`	`bool` Define si se filtrarán los usuarios inhabilitados. La configuración predeterminada es `False`.
`filter_support_users`	`bool` Define si se filtrarán los usuarios de asistencia. La configuración predeterminada es `False`.
`fetch_only_support_users`	`bool` Define si se deben devolver solo los usuarios de asistencia. La configuración predeterminada es `False`.
`filter_permission_types`	`list[int] \| None` Es una lista de tipos de permisos de filtro (p.ej., `0`). La configuración predeterminada es `None`.

Devoluciones

Es una lista de todos los usuarios.

Tipo de datos que se muestra

list[UserProfileCard]

TIPCommon.soar_ops.is_slo_comment

TIPCommon.soar_ops.is_slo_comment(comment: str)

Comprueba si un comentario es una advertencia de SLO.

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

Parámetros
`comment`	`str` Es el comentario que se verificará.

Devoluciones

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

Tipo de datos que se muestra

bool

TIPCommon.soar_ops.remove_prefix_from_comments

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

Quita un prefijo (si está presente) de una lista de comentarios.

Parámetros
`comments`	`list[str]` Comentarios de los que se quitará el prefijo.
`prefix`	`str` Es el prefijo que se quitará.

Devoluciones

Es una lista de todos los comentarios después de que se quitó el prefijo de ellos.

Tipo de datos que se muestra

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 una ruta de acceso local o en un bucket de Google Cloud .

Parámetros

Parámetros
`chronicle_soar`	`ChronicleSOAR` Es un objeto del SDK de Google Security Operations SOAR.
`path`	`str` Es la ruta de acceso a la carpeta en la que se deben guardar los archivos.
`name`	`str` Nombre del archivo que se guardará.
`content`	`bytes` Contenido del archivo en formato de bytes.

Devoluciones

Ruta de acceso a los archivos descargados.

Tipo de datos que se muestra

str | None

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