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

Cria um objeto de credenciais com base em uma conta de serviço, um e-mail de identidade da carga de trabalho ou atributos de conta de serviço.

Observação É necessário informar user_service_account, target_principal ou service_account_attr (usando **kwargs). Caso contrário, uma exceção EmptyMandatoryValues será gerada.

Parâmetros

Parâmetros
user_service_account SingleJson | None

O JSON da conta de serviço do usuário.
target_principal str | None

O e-mail da Identidade da carga de trabalho.
source_credentials google.auth.Credentials | None

A credencial de origem usada para adquirir as credenciais representadas.

Se None for fornecido, o sistema tentará usar as credenciais padrão do aplicativo.
quota_project_id str | None

O ID do projeto usado para cota e faturamento.
scopes list[str]

Os escopos de credenciais Google Cloud . O padrão é ['https://www.googleapis.com/auth/cloud-platform'].
verify_ssl bool

Defina se o certificado SSL será verificado.

O valor padrão é True.
service_account_attr dict[str, Any]

Pares de chave-valor de campos de conta de serviço desestruturados.

Gera

EmptyMandatoryValues: quando não há uma conta de serviço ou um e-mail de identidade da carga de trabalho ou quando faltam campos obrigatórios para a conta de serviço. google.auth.exceptions.RefreshError: quando não foi possível atualizar as credenciais.

Retorna

Um objeto de credenciais.

Tipo de retorno

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

Cria um objeto de credenciais com base nos atributos da conta de serviço.

Parâmetros

Parâmetros
account_type str

O tipo de conta de serviço.
project_id str

O ID do projeto da conta de serviço.
private_key_id str

O ID da chave privada da conta de serviço.
private_key str

A chave privada da conta de serviço.
client_email str

O e-mail do cliente da conta de serviço.
client_id str

O ID do cliente da conta de serviço.
auth_uri str

O URI de autenticação da conta de serviço.
token_uri str

O URI do token da conta de serviço.
auth_provider_x509_url str

O URL do certificado x509 do provedor de autenticação da conta de serviço.
client_x509_cert_url str

O URL do certificado x509 do cliente da conta de serviço.
scopes list[str], optional

Os escopos de credenciais Google Cloud . O padrão é ['https://www.googleapis.com/auth/cloud-platform'].
quota_project_id str | None

O ID do projeto usado para cota e faturamento.

Gera

EmptyMandatoryValues: quando campos obrigatórios da conta de serviço estão faltando.

Retorna

Um objeto de credenciais.

Tipo de retorno

service_account.Credentials

TIPCommon.rest.auth.generate_jwt_from_credentials

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

Gera um JSON Web Token para acessar recursos da API Google Cloud usando REST.

Parâmetros

Parâmetros
credentials google.oauth2.credentials.Credentials

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

Defina se o token de credenciais será atualizado por SSL.

O valor padrão é True.

Retorna

Um token JWT para usar no cabeçalho de autorização.

Tipo de retorno

bytes

TIPCommon.rest.auth.generate_jwt_from_sa

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

Gera um JSON Web Token para acessar recursos da API Google Cloud usando REST.

Parâmetros
service_account str | dict

Google Cloud conta de serviço do projeto com os papéis necessários do Identity and Access Management.
expiry_length int

Tempo definido até a expiração do token em segundos. O padrão é 1 hora.
audience str

Google Cloud escopo. Se não for fornecido, o padrão será https://www.googleapis.com/auth/cloud-platform.

Retorna

Um token JWT para usar no cabeçalho de autorização.

Tipo de retorno

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]

Recebe as Application Default Credentials (ADC) do ambiente de execução. Essa é uma função de wrapper para google.auth.default.

Parâmetros

Parâmetros
scopes Sequence[str] | None

A lista de escopos para as credenciais.

Se especificado, as credenciais serão automaticamente escopo quando necessário.
request google.auth.transport.Request | None

Um objeto usado para fazer solicitações HTTP. Usado para detectar se o aplicativo é executado no Compute Engine ou para determinar o ID do projeto associado a um recurso de pool de identidades da carga de trabalho (credenciais de conta externa).

Se não for especificado, ele usará o cliente HTTP da biblioteca padrão para credenciais do Compute Engine ou um cliente google.auth.transport.requests.Request para credenciais de contas externas.
quota_project_id str | None

O ID do projeto usado para cota e faturamento.

Retorna

As credenciais e o ID do projeto do ambiente atual. O ID do projeto pode ser None, o que indica que não foi possível determinar o ID do projeto no ambiente.

Tipo de retorno

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

Gera

google.auth.exceptions.DefaultCredentialsError: quando nenhuma credencial foi encontrada ou se as credenciais encontradas eram inválidas.

TIPCommon.rest.auth.get_auth_request

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

Cria uma solicitação HTTP autorizada para uma API de recurso Google Cloud .

Parâmetros

Parâmetros
verify_ssl bool, optional

Verifica o certificado SSL. O valor padrão é True.

Retorna

Um objeto de solicitação autorizada.

Tipo de retorno

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

Recebe um objeto Credentials de curta duração usando a representação da conta de serviço Google Cloud .

Parâmetros

Parâmetros
target_principal str

A conta de serviço a ser representada.
source_credentials google.auth.Credentials | None

A credencial de origem usada para adquirir as credenciais representadas.

Se nada for fornecido, o sistema tentará usar as credenciais padrão do aplicativo.
target_scopes Sequence[str] | None

Os escopos a serem solicitados durante a concessão de autorização.

Se None for fornecido, o escopo padrão https://www.googleapis.com/auth/cloud-platform será usado.
delegates Sequence[str] | None

A lista encadeada de delegados necessários para conceder o token de acesso final.

Se definido, a sequência de identidades precisa ter a capacidade Service Account Token Creator concedida à identidade anterior.

Por exemplo, se definido como [serviceAccountB, serviceAccountC], o source_credential precisará ter a função de criador de token em serviceAccountB. serviceAccountB precisa ter o criador de token em serviceAccountC. Por fim, C precisa ter o papel de criador de token em target_principal.

Se não for definido, source_credential precisará ter esse papel em target_principal.
quota_project_id str | None

O ID do projeto usado para cota e faturamento.

Observação: esse projeto pode ser diferente daquele usado para criar as credenciais.

Retorna

Um objeto Credentials de curta duração do principal de destino.

Tipo de retorno

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

Recebe as credenciais de conta de serviço de curta duração do locatário do SIEM da instância do Google SecOps.

Parâmetros

Parâmetros
chronicle_soar TIPCommon.types.ChronicleSOAR

O objeto do SDK do Google Security Operations SOAR.
target_scopes Sequence[str] | None

Os escopos a serem solicitados durante a concessão de autorização.
quota_project_id str | None

O ID do projeto usado para cota e faturamento.

Observação: esse projeto pode ser diferente daquele usado para criar as credenciais.

Retorna

Credenciais de conta de serviço de curta duração do locatário do SIEM.

Tipo de retorno

impersonated_credentials.Credentials

class TIPCommon.rest.gcp.GcpErrorReason

class TIPCommon.rest.gcp.GcpErrorReason

Bases: object

O namespace de constantes Google Cloud Error Reason.

Constantes

  • IAM_PERMISSION_DENIED = 'IAM_PERMISSION_DENIED'

class TIPCommon.rest.gcp.GcpPermissions

class TIPCommon.rest.gcp.GcpPermissions

Bases: object

O namespace 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

Extrai o ID do projeto do e-mail da conta de serviço.

Parâmetros

Parâmetros
service_account_email str

O e-mail da conta de serviço.

Retorna

O código do projeto.

Tipo de retorno

str

Gera

NotFoundError: quando não é possível analisar o nome do projeto no e-mail da 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

Extrai o ID do projeto da chave JSON da conta de serviço.

Parâmetros

Parâmetros
service_account_json SingleJson

A chave JSON da conta de serviço.

Retorna

Campo "ID do projeto" da chave da conta de serviço.

Tipo de retorno

str

Gera

NotFoundError: quando não é possível encontrar o campo "project_id" na chave da conta de serviço.

TIPCommon.rest.gcp.get_http_client

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

Recebe um cliente HTTP autorizado Google Cloud .

Parâmetros

Parâmetros
credentials service_account.Credentials

Um objeto Google Cloud Credentials.
verify_ssl bool, opcional

Verifica o certificado SSL. O valor padrão é True.

Retorna

O cliente HTTP autorizado.

Tipo de retorno

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 o e-mail da conta de serviço da carga de trabalho do servidor de metadados Google Cloud .

Parâmetros

Parâmetros
default_sa_to_return str | None

Conta de serviço padrão a ser retornada se não for encontrada.

O valor padrão é None.

Retorna

O e-mail da conta de serviço do Workload.

Tipo de retorno

str

Gera

GoogleCloudException: quando não é possível receber o e-mail da conta de serviço da carga de trabalho do 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

Recebe o ID do projeto de uma conta de serviço ou de um e-mail de identidade da carga de trabalho.

Parâmetros

Parâmetros
user_service_account SingleJson | None

O JSON da conta de serviço do usuário.
service_account_email str | None

O e-mail da Identidade da carga de trabalho.
default_project_id str | None

O ID do projeto padrão a ser retornado se não for encontrado.

Se fornecida, essa função não vai gerar NotFoundError.

O valor padrão é None.

Retorna

O ID do projeto da conta de serviço ou do e-mail da identidade da carga de trabalho. Se não for encontrado, retorna None.

Tipo de retorno

str | None

Gera

NotFoundError: quando não é possível analisar o nome do projeto no e-mail da SA.

TIPCommon.rest.gcp.validate_impersonation

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

Valida a representação da conta de serviço de uma resposta autorizada HTTP.

Parâmetros

Parâmetros
content dict

O conteúdo da resposta HTTP autorizada.
default_error_msg str, optional

Uma mensagem de erro a ser gerada se não for encontrada no conteúdo da resposta.

O valor padrão é "Service Account Impersonation failed".

Retorna

None se a representação da conta de serviço estiver autorizada.

Tipo de retorno

None

Gera

ImpersonationUnauthorizedError: quando a representação da conta de serviço não está autorizada.

TIPCommon.rest.httplib.get_auth_session

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

Cria uma sessão HTTP autorizada para uma API de recurso Google Cloud .

Parâmetros
service_account str | dict

Uma conta de serviço do projeto Google Cloud com os papéis necessários do Identity and Access Management.
audience str

O escopo Google Cloud .
verify_ssl bool

Define se uma sessão com criptografia SSL será criada.

Retorna

Um objeto de sessão autorizado.

Tipo de retorno

requests.Session

Gera

ValueError: quando as credenciais e a conta de serviço não são fornecidas.

exception TIPCommon.rest.soar_api.SoarApiServerError

Bases: Exception

Erros das chamadas de API do SOAR das Operações de segurança do Google para o 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]

Os lotes definem valores de campos personalizados.

Parâmetros

Parâmetros
chronicle_soar Um objeto do SDK do Google Security Operations SOAR.
identifier int

O identificador principal.
parent str

O caminho principal para o valor do campo personalizado (por exemplo, cases/1, cases/1/alerts/1).
custom_fields_values_mapping dict[int, list[str]]

Mapeamento de IDs de campos personalizados para valores.

Retorna

Lista de objetos CustomFieldValue.

Tipo de retorno

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]

Recebe eventos de um alerta específico.

Parâmetros

Parâmetros
chronicle_soar ChronicleSOAR

Um objeto do SDK do Google Security Operations SOAR.
case_id str | int

O ID do caso. Exemplo: 13, "41".
alert_identifier str

O identificador do alerta (por exemplo, '{alert.name}_{alert.id}').

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

Retorna

O JSON de resposta da solicitação. Uma lista de JSONs de eventos.

Tipo de retorno

list[SingleJson]

Gera

requests.HTTPError: quando o servidor retorna um código de status que não indica sucesso. json.JSONDecodeError: quando o valor retornado não é um 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]

Recebe anexos de caso.

Parâmetros

Parâmetros
chronicle_soar ChronicleSOAR

Um objeto do SDK do Google Security Operations SOAR.
case_id int

O ID do caso do Google Security Operations SOAR.

Retorna

Um mapeamento mutável que representa os anexos do caso.

Tipo de retorno

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

Recebe detalhes da visão geral do caso por ID.

Parâmetros
chronicle_soar ChronicleSOAR

Um objeto do SDK do Google Security Operations.
case_id int | str

O ID do caso do Google Security Operations SOAR.

Retorna

O objeto de detalhes do caso.

Tipo de retorno

(CaseDetails)

Gera

requests.HTTPError: quando uma solicitação falha ou o status dela não é 200. json.JSONDecoderError: quando a análise da resposta falha.

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]

Recebe todos os cards de conector.

Parâmetros

Parâmetros
chronicle_soar ChronicleSOAR

Um objeto do SDK do Google Security Operations SOAR.
integration_name str | None

O nome da integração.
connector_identifier str | None

O ID do conector.

Retorna

Uma lista de todos os cards de conector.

Tipo de retorno

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]

Busca dados de entidade.

Parâmetros

Parâmetros
chronicle_soar ChronicleSOAR

Um objeto do SDK do Google Security Operations SOAR.
entity_identifier int

O identificador da entidade.
entity_environment str

O ambiente da entidade.
entity_type str

O tipo de entidade.
last_case_type int

O último tipo de caso.
case_distribution_type int

O tipo de distribuição de casos.

Retorna

Um mapeamento mutável que representa os dados da entidade.

Tipo de retorno

dict

Gera

requests.HTTPError: quando o servidor retorna um código de status que não indica sucesso.

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 uma lista de arquivos de definição de ação de ambiente.

Parâmetros
chronicle_soar ChronicleSOAR

Um objeto do SDK do Google SecOps.

Retorna

Uma lista de objetos SingleJson que representam os arquivos de definição de ação.

Tipo de retorno

(list[SingleJson])

Gera

requests.HTTPError: quando o servidor retorna um código de status de falha. json.JSONDecodeError: quando o valor retornado não é um 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]

Recebe casos de federação.

Parâmetros

Parâmetros
chronicle_soar ChronicleSOAR

Um objeto do SDK do Google Security Operations SOAR.

Retorna

Resposta JSON.

Tipo de retorno

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]

Recebe detalhes completos do caso.

Parâmetros

Parâmetros
chronicle_soar ChronicleSOAR

Um objeto do SDK do Google Security Operations SOAR.
case_id int

O ID do caso do Google Security Operations SOAR.

Retorna

Um mapeamento mutável que representa todos os detalhes do caso.

Tipo de retorno

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]

Busca todas as integrações instaladas para os ambientes fornecidos.

Parâmetros

Parâmetros
chronicle_soar ChronicleSOAR

Um objeto do SDK do Google Security Operations SOAR.
environment str

A lista de ambientes da instância.
integration_identifier str | None

O ID da integração.

Retorna

Uma lista de objetos de dicionário que representam instâncias de integração.

Tipo de retorno

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 uma lista de arquivos de definição de ação de ambiente.

Parâmetros
chronicle_soar ChronicleSOAR

Um objeto do SDK do Google SecOps.

Retorna

Uma lista de objetos SingleJson que representam os arquivos de definição de ação.

Tipo de retorno

(list[SingleJson])

Gera

requests.HTTPError: quando o servidor retorna um código de status de falha. json.JSONDecodeError: quando o valor retornado não é um 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 o arquivo com todos os detalhes da integração.

Parâmetros
chronicle_soar ChronicleSOAR

Um objeto do SDK do Google SecOps.
integration_identifier str

O ID da integração.

Retorna

Uma resposta JSON com todos os detalhes da integração.

Tipo de retorno

(SingleJSON)

Gera

requests.HTTPError: quando o servidor retorna um código de status de falha. json.JSONDecodeError: quando o valor retornado não é um 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 cards de perfil de usuário por página e filtro.

Parâmetros

Parâmetros
chronicle_soar ChronicleSOAR

Um objeto do SDK do Google Security Operations SOAR.
search_term str

Os termos de pesquisa.
requested_page int

O deslocamento inicial para retornar uma página de usuários.
page_size int

O número de usuários a serem retornados.
filter_by_role bool

Defina se é necessário filtrar por função.
filter_disabled_users bool

Defina se os usuários desativados devem ser filtrados.
filter_support_users bool

Defina se os usuários de suporte devem ser filtrados.
fetch_only_support_users bool

Defina se você quer retornar apenas usuários de suporte.
filter_permission_types list[int] | None

Uma lista de tipos de permissão de filtro (por exemplo, 0).

Retorna

A resposta do servidor SOAR: o card de perfil do usuário.

Tipo de retorno

SingleJson

Gera

requests.HTTPError: quando o servidor retorna um código de status que não indica sucesso. json.JSONDecodeError: quando o valor retornado não é um JSON válido.

Exemplo

Exemplo de JSON de resposta:

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

Recebe um card de instância de fluxo de trabalho.

Parâmetros

Parâmetros
chronicle_soar ChronicleSOAR

Um objeto do SDK do Google Security Operations SOAR.
case_id int

O ID do caso do Google Security Operations SOAR.
alert_identifier str

O ID do alerta do Google Security Operations SOAR.

Retorna

Um mapeamento mutável que representa o card da instância de fluxo de trabalho.

Tipo de retorno

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]

Recebe valores de campos personalizados para um caso ou alerta.

Parâmetros

Parâmetros
chronicle_soar ChronicleSOAR

Um objeto do SDK do Google Security Operations SOAR.
parent str

O caminho principal do valor do campo personalizado (por exemplo, cases/1, cases/1/alerts/1).

Retorna

O objeto de detalhes do caso.

Tipo de retorno

list[CustomFieldValue]

Gera

requests.HTTPError: quando a solicitação falha ou o status dela não é 200. json.JSONDecoderError: quando a análise da resposta falha.

TIPCommon.rest.soar_api.list_custom_fields

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

Lista os campos personalizados.

Parâmetros

Parâmetros
chronicle_soar ChronicleSOAR

Um objeto do SDK do Google Security Operations SOAR.
filter_ str | None

O valor do filtro para a pesquisa.

Retorna

O objeto de detalhes do caso.

Tipo de retorno

list[CustomField]

Gera

requests.HTTPError: quando a solicitação falha ou o status dela não é 200. json.JSONDecoderError: quando a análise da resposta falha.

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

Remove uma tag de caso.

Parâmetros

Parâmetros
chronicle_soar ChronicleSOAR

Um objeto do SDK do Google Security Operations SOAR.
case_id int

O ID do caso do Google Security Operations SOAR.
tag str

Uma tag a ser removida.
alert_identifier str | None

O ID do alerta {google_secops_soar_name}.

Retorna

Nenhuma.

Tipo de retorno

None

Gera

requests.HTTPError: quando o servidor retorna um código de status que não indica sucesso.

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 um arquivo diretamente na parede de casos.

Parâmetros

Parâmetros
chronicle_soar ChronicleSOAR

Um objeto do SDK do Google Security Operations SOAR.
attachment_data CaseWallAttachment

Um objeto CaseWallAttachment.

Retorna

Um mapeamento mutável que representa a resposta da API.

Tipo de retorno

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 a prioridade do alerta.

Parâmetros

Parâmetros
chronicle_soar ChronicleSOAR

Um objeto do SDK do Google Security Operations SOAR.
case_id int

O ID do caso do Google Security Operations SOAR.
alert_identifier str

O ID do alerta do Google Security Operations SOAR.
alert_name str

O nome do alerta do Google Security Operations SOAR.
priority int

O valor de enumeração de prioridade do Google Security Operations SOAR.

Retorna

Nenhuma.

Tipo de retorno

None

Gera

requests.HTTPError: quando o servidor retorna um código de status que não indica sucesso.

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 pontuações de caso em massa.

Parâmetros

Parâmetros
chronicle_soar ChronicleSOAR

Um objeto do SDK do Google Security Operations SOAR.
case_score_mapping list[dict[str, int | float]]

Um mapeamento de ID de caso do SOAR do Google Security Operations para pontuação.

Retorna

Um JSON de resposta que contém o status de sucesso e, se aplicável, listas de casos com falha.

Tipo de retorno

MutableMapping[str, Any]

Gera

requests.HTTPError: quando o servidor retorna um código de status que não indica sucesso.

Exemplo

{
  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 valores de campos personalizados.

Parâmetros

Parâmetros
chronicle_soar ChronicleSOAR

Um objeto do SDK do Google Security Operations SOAR.
parent str

O caminho principal do valor do campo personalizado, por exemplo: cases/1, cases/1/alerts/1.
custom_field_id int

O ID do campo personalizado.
values list[str]

Uma lista de valores de campos personalizados a serem definidos.

Retorna

Um objeto CustomFieldValue.

Tipo de retorno

CustomFieldValue

TIPCommon.rest.soar_api.validate_response

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

Valida a resposta e a retorna como JSON.

Parâmetros
response requests.Response

A resposta a ser validada.

Gera

HTTPError: quando o código de status da resposta indica uma falha.

Precisa de mais ajuda? Receba respostas de membros da comunidade e profissionais do Google SecOps.