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 objeto de credenciales a partir de una cuenta de servicio, un correo de identidad de carga de trabajo o atributos de 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

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

El correo de la identidad de carga de trabajo.
source_credentials google.auth.Credentials | None

La credencial de origen usada para obtener las credenciales suplantadas.

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

El ID de proyecto que se usa para la cuota y la facturación.
scopes list[str]

Los ámbitos de las credenciales de Google Cloud . El valor predeterminado es ['https://www.googleapis.com/auth/cloud-platform'].
verify_ssl bool

Define si se debe verificar el certificado SSL.

El valor predeterminado es True.
service_account_attr dict[str, Any]

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

Aumentos

EmptyMandatoryValues: cuando no hay una cuenta de servicio o un correo de identidad de carga de trabajo, o si faltan campos obligatorios de la cuenta de servicio. google.auth.exceptions.RefreshError: cuando no se han podido actualizar las credenciales.

Devoluciones

Un objeto de credenciales.

Tipo de devolución

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 objeto de credenciales a partir de los atributos de la cuenta de servicio.

Parámetros

Parámetros
account_type str

El tipo de cuenta de servicio.
project_id str

El ID del proyecto de la cuenta de servicio.
private_key_id str

El ID de la clave privada de la cuenta de servicio.
private_key str

Clave privada de la cuenta de servicio.
client_email str

El correo del cliente de la cuenta de servicio.
client_id str

El ID de cliente de la cuenta de servicio.
auth_uri str

El URI de autenticación de la cuenta de servicio.
token_uri str

El URI del token de la cuenta de servicio.
auth_provider_x509_url str

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

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

Los ámbitos de las credenciales de Google Cloud . El valor predeterminado es ['https://www.googleapis.com/auth/cloud-platform'].
quota_project_id str | None

El ID de proyecto que se usa para la cuota y la facturación.

Aumentos

EmptyMandatoryValues: cuando faltan campos obligatorios de la cuenta de servicio.

Devoluciones

Un objeto de credenciales.

Tipo de devolución

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 mediante REST.

Parámetros

Parámetros
credentials google.oauth2.credentials.Credentials

Objeto google.oauth2.credentials.Credentials.
verify_ssl bool

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

El valor predeterminado es True.

Devoluciones

Un token JWT que se usará en el encabezado Authorization.

Tipo de devolución

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 mediante REST.

Parámetros
service_account str | dict

Google Cloud Cuenta de servicio del proyecto con los roles de Gestión de Identidades y Accesos necesarios.
expiry_length int

Tiempo establecido hasta que caduque el token en segundos. El valor predeterminado es 1 hora.
audience str

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

Devoluciones

Un token JWT que se usará en el encabezado de autorización.

Tipo de devolución

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 de aplicación predeterminadas (ADC) del entorno de ejecución. Se trata de una función de envoltorio para google.auth.default.

Parámetros

Parámetros
scopes Sequence[str] | None

Lista de ámbitos de las credenciales.

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

Objeto que se usa para hacer solicitudes HTTP. Se usa para detectar si la aplicación se ejecuta en Compute Engine o para determinar el ID de proyecto asociado de un recurso de 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 google.auth.transport.requests.Request para las credenciales de cuentas externas.
quota_project_id str | None

El ID de proyecto que se usa para la cuota y la facturación.

Devoluciones

Las credenciales y el ID del proyecto del entorno actual. El ID de proyecto puede ser None, lo que indica que no se ha podido determinar a partir del entorno.

Tipo de devolución

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

Aumentos

google.auth.exceptions.DefaultCredentialsError: cuando no se han encontrado credenciales o si las credenciales encontradas no son válidas.

TIPCommon.rest.auth.get_auth_request

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

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

Parámetros

Parámetros
verify_ssl bool, optional

Verifica el certificado SSL. El valor predeterminado es True.

Devoluciones

Un objeto de solicitud autorizado.

Tipo de devolución

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 duración reducida mediante la Google Cloud suplantación de identidad de cuenta de servicio.

Parámetros

Parámetros
target_principal str

La cuenta de servicio cuya identidad se va a suplantar.
source_credentials google.auth.Credentials | None

La credencial de origen usada para obtener las credenciales suplantadas.

Si no se indica ningún parámetro, el sistema intentará usar las credenciales predeterminadas de la aplicación.
target_scopes Sequence[str] | None

Los permisos que se solicitan durante la concesión de autorización.

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

La lista encadenada de delegados necesarios para conceder el token de acceso final.

Si se define, la secuencia de identidades debe tener la función Service Account Token Creator concedida a la identidad anterior.

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

Si no se define ningún valor, source_credential debe tener ese rol en target_principal.
quota_project_id str | None

El ID de proyecto que se usa para la cuota y la facturación.

Nota: Este proyecto puede ser diferente del que se ha usado para crear las credenciales.

Devoluciones

Objeto Credentials de duración reducida de la entidad de seguridad de destino.

Tipo de devolución

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 duración reducida del tenant de SIEM de la instancia de Google SecOps.

Parámetros

Parámetros
chronicle_soar TIPCommon.types.ChronicleSOAR

Objeto del SDK de Google Security Operations SOAR.
target_scopes Sequence[str] | None

Los permisos que se solicitan durante la concesión de autorización.
quota_project_id str | None

El ID de proyecto que se usa para la cuota y la facturación.

Nota: Este proyecto puede ser diferente del que se ha usado para crear las credenciales.

Devoluciones

Credenciales de cuenta de servicio de duración reducida del arrendatario de SIEM.

Tipo de devolución

impersonated_credentials.Credentials

class TIPCommon.rest.gcp.GcpErrorReason

clase TIPCommon.rest.gcp.GcpErrorReason

Bases: object

El espacio de nombres de constantes Google Cloud Error Reason.

Constantes

  • IAM_PERMISSION_DENIED = 'IAM_PERMISSION_DENIED'

class TIPCommon.rest.gcp.GcpPermissions

clase TIPCommon.rest.gcp.GcpPermissions

Bases: object

El espacio de nombres de constantes 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 de proyecto del correo de la cuenta de servicio.

Parámetros

Parámetros
service_account_email str

El correo de la cuenta de servicio.

Devoluciones

El ID del proyecto.

Tipo de devolución

str

Aumentos

NotFoundError: cuando no puede analizar el nombre del proyecto a partir del correo del administrador de servicios.

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

La clave JSON de la cuenta de servicio.

Devoluciones

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

Tipo de devolución

str

Aumentos

NotFoundError: cuando no se encuentra 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 Google Cloud cliente HTTP autorizado.

Parámetros

Parámetros
credentials service_account.Credentials

Un objeto Google Cloud Credentials.
verify_ssl bool (opcional)

Verifica el certificado SSL. El valor predeterminado es True.

Devoluciones

El cliente HTTP autorizado.

Tipo de devolución

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

Obtiene el correo de la cuenta de servicio de la carga de trabajo del Google Cloud servidor de metadatos.

Parámetros

Parámetros
default_sa_to_return str | None

Cuenta de servicio predeterminada que se devuelve si no se encuentra ninguna.

El valor predeterminado es None.

Devoluciones

Correo de la cuenta de servicio de la carga de trabajo.

Tipo de devolución

str

Aumentos

GoogleCloudException: cuando no se puede obtener el correo de la cuenta de servicio de Workload de GCP.

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 de proyecto de una cuenta de servicio o un correo de identidad de carga de trabajo.

Parámetros

Parámetros
user_service_account SingleJson | None

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

El correo de la identidad de carga de trabajo.
default_project_id str | None

El ID de proyecto predeterminado que se devolverá si no se encuentra.

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

El valor predeterminado es None.

Devoluciones

El ID de proyecto de la cuenta de servicio o el correo de identidad de carga de trabajo. Si no se encuentra, devuelve None.

Tipo de devolución

str | None

Aumentos

NotFoundError: cuando no se puede analizar el nombre del proyecto a partir del correo de la cuenta de servicio.

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 de HTTP.

Parámetros

Parámetros
content dict

El contenido de la respuesta HTTP autorizada.
default_error_msg str, optional

Mensaje de error que se debe generar si no se encuentra en el contenido de la respuesta.

El valor predeterminado es "Service Account Impersonation failed".

Devoluciones

None si la suplantación de identidad de la cuenta de servicio está autorizada.

Tipo de devolución

None

Aumentos

ImpersonationUnauthorizedError: cuando no se autoriza la suplantación 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 Google Cloud cuenta de servicio del proyecto con los roles de Gestión de Identidades y Accesos necesarios.
audience str

El Google Cloud ámbito.
verify_ssl bool

Define si se debe crear una sesión con cifrado SSL.

Devoluciones

Un objeto de sesión autorizado.

Tipo de devolución

requests.Session

Aumentos

ValueError: cuando no se proporcionan credenciales ni una cuenta de servicio.

excepción TIPCommon.rest.soar_api.SoarApiServerError

Bases: Exception

Errores de las llamadas a la API de 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 definen los valores de los campos personalizados.

Parámetros

Parámetros
chronicle_soar Objeto del SDK de Google Security Operations SOAR.
identifier int

Identificador principal.
parent str

Ruta principal del valor del campo personalizado (por ejemplo, cases/1 o cases/1/alerts/1).
custom_fields_values_mapping dict[int, list[str]]

Asignación de IDs de campos personalizados a valores.

Devoluciones

Lista de objetos CustomFieldValue.

Tipo de devolución

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

Objeto del SDK de Google Security Operations SOAR.
case_id str | int

El ID de asistencia. Ejemplo: 13, "41".
alert_identifier str

Identificador de la alerta (por ejemplo, '{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

El JSON de respuesta de la solicitud. Una lista de JSONs de eventos.

Tipo de devolución

list[SingleJson]

Aumentos

requests.HTTPError: cuando el servidor devuelve un código de estado que no indica que la solicitud se ha realizado correctamente. 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 de un caso.

Parámetros

Parámetros
chronicle_soar ChronicleSOAR

Objeto del SDK de Google Security Operations SOAR.
case_id int

El ID de asistencia de Google Security Operations SOAR.

Devoluciones

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

Tipo de devolución

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

Obtiene los detalles generales de un caso de asistencia por su ID.

Parámetros
chronicle_soar ChronicleSOAR

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

El ID de asistencia de Google Security Operations SOAR.

Devoluciones

El objeto de detalles del caso.

Tipo de devolución

(CaseDetails)

Aumentos

requests.HTTPError: cuando falla una solicitud o el estado de la solicitud no es 200. json.JSONDecoderError: cuando no se puede analizar 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

Objeto del SDK de Google Security Operations SOAR.
integration_name str | None

Nombre de la integración.
connector_identifier str | None

El ID del conector.

Devoluciones

Lista de todas las tarjetas de conector.

Tipo de devolución

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]

Obtiene los datos de la entidad.

Parámetros

Parámetros
chronicle_soar ChronicleSOAR

Objeto del SDK de Google Security Operations SOAR.
entity_identifier int

Identificador de la entidad.
entity_environment str

El entorno de la entidad.
entity_type str

El tipo de entidad.
last_case_type int

El último tipo de caso.
case_distribution_type int

Tipo de distribución del caso.

Devoluciones

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

Tipo de devolución

dict

Aumentos

requests.HTTPError: cuando el servidor devuelve un código de estado que no indica que la solicitud se ha realizado correctamente.

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

Obtiene una lista de archivos de definición de acciones de entorno.

Parámetros
chronicle_soar ChronicleSOAR

Objeto del SDK de Google SecOps.

Devoluciones

Lista de objetos SingleJson que representan los archivos de definición de acciones.

Tipo de devolución

(list[SingleJson])

Aumentos

requests.HTTPError: cuando el servidor devuelve un código de estado que no indica que la operación se ha realizado correctamente. 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

Objeto del SDK de Google Security Operations SOAR.

Devoluciones

JSON de respuesta.

Tipo de devolución

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 todos los detalles del caso.

Parámetros

Parámetros
chronicle_soar ChronicleSOAR

Objeto del SDK de Google Security Operations SOAR.
case_id int

El ID de asistencia de Google Security Operations SOAR.

Devoluciones

Una asignación mutable que representa todos los detalles del caso.

Tipo de devolución

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]

Obtiene todas las integraciones instaladas en los entornos proporcionados.

Parámetros

Parámetros
chronicle_soar ChronicleSOAR

Objeto del SDK de Google Security Operations SOAR.
environment str

Lista de entornos de la instancia.
integration_identifier str | None

El ID de integración.

Devoluciones

Lista de objetos de diccionario que representan instancias de integración.

Tipo de devolución

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

Obtiene una lista de archivos de definición de acciones de entorno.

Parámetros
chronicle_soar ChronicleSOAR

Objeto del SDK de Google SecOps.

Devoluciones

Lista de objetos SingleJson que representan los archivos de definición de acciones.

Tipo de devolución

(list[SingleJson])

Aumentos

requests.HTTPError: cuando el servidor devuelve un código de estado que no indica que la operación se ha realizado correctamente. 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]

Obtiene el archivo de detalles completo de la integración.

Parámetros
chronicle_soar ChronicleSOAR

Objeto del SDK de Google SecOps.
integration_identifier str

El ID de integración.

Devoluciones

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

Tipo de devolución

(SingleJSON)

Aumentos

requests.HTTPError: cuando el servidor devuelve un código de estado que no indica que la operación se ha realizado correctamente. 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]

Obtiene tarjetas de perfil de usuario por página y filtro.

Parámetros

Parámetros
chronicle_soar ChronicleSOAR

Objeto del SDK de Google Security Operations SOAR.
search_term str

Los términos de búsqueda.
requested_page int

Desplazamiento inicial para devolver la página de un usuario.
page_size int

Número de usuarios que se van a devolver.
filter_by_role bool

Define si quieres filtrar por rol.
filter_disabled_users bool

Define si se deben excluir los usuarios inhabilitados.
filter_support_users bool

Define si quieres excluir a los usuarios del servicio de asistencia.
fetch_only_support_users bool

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

Lista de tipos de permisos de filtro (por ejemplo, 0).

Devoluciones

La respuesta del servidor de SOAR: la tarjeta de perfil del usuario.

Tipo de devolución

SingleJson

Aumentos

requests.HTTPError: cuando el servidor devuelve un código de estado que no indica que la solicitud se ha realizado correctamente. json.JSONDecodeError: cuando el valor devuelto no es un JSON válido.

Ejemplo

Ejemplo de JSON de respuesta:

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

Objeto del SDK de Google Security Operations SOAR.
case_id int

El ID de asistencia de Google Security Operations SOAR.
alert_identifier str

ID de alerta de Google Security Operations SOAR.

Devoluciones

Una asignación mutable que representa la tarjeta de instancia del flujo de trabajo.

Tipo de devolución

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 de un caso o una alerta.

Parámetros

Parámetros
chronicle_soar ChronicleSOAR

Objeto del SDK de Google Security Operations SOAR.
parent str

Ruta principal del valor del campo personalizado (por ejemplo: cases/1, cases/1/alerts/1).

Devoluciones

El objeto de detalles del caso.

Tipo de devolución

list[CustomFieldValue]

Aumentos

requests.HTTPError: cuando la solicitud falla o el estado de la solicitud no es 200. json.JSONDecoderError: cuando no se puede 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]

Lista los campos personalizados.

Parámetros

Parámetros
chronicle_soar ChronicleSOAR

Objeto del SDK de Google Security Operations SOAR.
filter_ str | None

Valor de filtro de la búsqueda.

Devoluciones

El objeto de detalles del caso.

Tipo de devolución

list[CustomField]

Aumentos

requests.HTTPError: cuando la solicitud falla o el estado de la solicitud no es 200. json.JSONDecoderError: cuando no se puede 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

Elimina una etiqueta de caso.

Parámetros

Parámetros
chronicle_soar ChronicleSOAR

Objeto del SDK de Google Security Operations SOAR.
case_id int

El ID de asistencia de Google Security Operations SOAR.
tag str

Etiqueta que se va a quitar.
alert_identifier str | None

ID de alerta de {google_secops_soar_name}.

Devoluciones

Ninguno

Tipo de devolución

None

Aumentos

requests.HTTPError: cuando el servidor devuelve un código de estado que no indica que la solicitud se ha realizado correctamente.

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 el muro del caso.

Parámetros

Parámetros
chronicle_soar ChronicleSOAR

Objeto del SDK de Google Security Operations SOAR.
attachment_data CaseWallAttachment

Objeto CaseWallAttachment.

Devoluciones

Una asignación mutable que representa la respuesta de la API.

Tipo de devolución

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

Define la prioridad de la alerta.

Parámetros

Parámetros
chronicle_soar ChronicleSOAR

Objeto del SDK de Google Security Operations SOAR.
case_id int

El ID de asistencia de Google Security Operations SOAR.
alert_identifier str

ID de alerta de Google Security Operations SOAR.
alert_name str

Nombre de la alerta de Google Security Operations SOAR.
priority int

Valor de enumeración de prioridad de Google Security Operations SOAR.

Devoluciones

Ninguno

Tipo de devolución

None

Aumentos

requests.HTTPError: cuando el servidor devuelve un código de estado que no indica que la solicitud se ha realizado correctamente.

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]

Define las puntuaciones de casos en bloque.

Parámetros

Parámetros
chronicle_soar ChronicleSOAR

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

Una asignación de ID de asistencia de Google Security Operations SOAR a Puntuación.

Devoluciones

Un archivo JSON de respuesta que contiene el estado de éxito y, si procede, listas de casos fallidos.

Tipo de devolución

MutableMapping[str, Any]

Aumentos

requests.HTTPError: cuando el servidor devuelve un código de estado que no indica que la solicitud se ha realizado correctamente.

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

Define los valores de los campos personalizados.

Parámetros

Parámetros
chronicle_soar ChronicleSOAR

Objeto del SDK de Google Security Operations SOAR.
parent str

Ruta principal del valor del campo personalizado. Por ejemplo: cases/1, cases/1/alerts/1.
custom_field_id int

El ID del campo personalizado.
values list[str]

Lista de valores de campos personalizados que se van a definir.

Devoluciones

Un objeto CustomFieldValue.

Tipo de devolución

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

La respuesta que se va a validar.

Aumentos

HTTPError: cuando el código de estado de la respuesta indica un error.

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