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 a partir de uma conta de serviço, de um email de identidade da carga de trabalho ou de atributos da conta de serviço.

Nota Tem de fornecer user_service_account, target_principal ou service_account_attr (com **kwargs). Caso contrário, é gerada uma exceção EmptyMandatoryValues.

Parâmetros

Parâmetros
user_service_account SingleJson | None

O JSON da conta de serviço do utilizador.
target_principal str | None

O email do Workload Identity.
source_credentials google.auth.Credentials | None

A credencial de origem usada para adquirir as credenciais roubadas.

Se None for fornecido, o sistema tenta usar as credenciais predefinidas da aplicação.
quota_project_id str | None

O ID do projeto usado para a quota e a faturação.
scopes list[str]

Os Google Cloud âmbitos das credenciais. A predefinição é ['https://www.googleapis.com/auth/cloud-platform'].
verify_ssl bool

Defina se o certificado SSL deve ser validado.

A predefinição é True.
service_account_attr dict[str, Any]

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

Aumenta

EmptyMandatoryValues – Quando não existe um email de conta de serviço ou de identidade da carga de trabalho, ou se faltarem campos obrigatórios para a conta de serviço. google.auth.exceptions.RefreshError: quando não foi possível atualizar as credenciais.

Devoluções

Um objeto de credenciais.

Tipo devolvido

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 a partir de 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 email do cliente da conta de serviço.
client_id str

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

O URI de autorizaçã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 X.509 do fornecedor 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 Google Cloud âmbitos das credenciais. A predefinição é ['https://www.googleapis.com/auth/cloud-platform'].
quota_project_id str | None

O ID do projeto usado para a quota e a faturação.

Aumenta

EmptyMandatoryValues: quando faltam campos obrigatórios para a conta de serviço.

Devoluções

Um objeto de credenciais.

Tipo devolvido

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 símbolo da Web JSON para aceder aos Google Cloud recursos da API através de 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 deve ser atualizado através de SSL.

A predefinição é True.

Devoluções

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

Tipo devolvido

bytes

TIPCommon.rest.auth.generate_jwt_from_sa

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

Gera um símbolo da Web JSON para aceder aos Google Cloud recursos da API através de REST.

Parâmetros
service_account str | dict

Google Cloud conta de serviço do projeto com as funções de gestão de identidade e de acesso necessárias.
expiry_length int

Tempo definido até o token expirar em segundos. A predefinição é 1 hora.
audience str

Google Cloud scope. Se não for fornecido, volta a ser https://www.googleapis.com/auth/cloud-platform.

Devoluções

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

Tipo devolvido

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]

Obtém as Credenciais padrão da aplicação (ADC) do ambiente de tempo de execução. Esta é uma função de wrapper para google.auth.default.

Parâmetros

Parâmetros
scopes Sequence[str] | None

A lista de âmbitos das credenciais.

Se forem especificadas, as credenciais são automaticamente delimitadas quando necessário.
request google.auth.transport.Request | None

Um objeto usado para fazer pedidos HTTP. Isto é usado para detetar se a aplicação é executada no Compute Engine ou para determinar o ID do projeto associado a um recurso do conjunto de identidades de carga de trabalho (credenciais de contas externas).

Se não for especificado, usa 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 a quota e a faturação.

Devoluções

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 a partir do ambiente.

Tipo devolvido

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

Aumenta

google.auth.exceptions.DefaultCredentialsError – Quando não foram encontradas credenciais ou se as credenciais encontradas forem inválidas.

TIPCommon.rest.auth.get_auth_request

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

Cria um pedido HTTP autorizado a uma Google Cloud API de recursos.

Parâmetros

Parâmetros
verify_ssl bool, optional

Valida o certificado SSL. A predefinição é True.

Devoluções

Um objeto de pedido autorizado.

Tipo devolvido

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

Obtém um objeto Credentials de curta duração através da Google Cloud simulação da conta de serviço.

Parâmetros

Parâmetros
target_principal str

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

A credencial de origem usada para adquirir as credenciais roubadas.

Se não for especificada nenhuma opção, o sistema tenta usar as credenciais predefinidas da aplicação.
target_scopes Sequence[str] | None

Os âmbitos a pedir durante a concessão de autorização.

Se None for fornecido, é usado o âmbito https://www.googleapis.com/auth/cloud-platform predefinido.
delegates Sequence[str] | None

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

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

Por exemplo, se estiver definido como [serviceAccountB, serviceAccountC], o source_credential tem de ter a função de criador de tokens em serviceAccountB. serviceAccountB tem de ter o criador de tokens em serviceAccountC. Por último, C tem de ter o criador de tokens em target_principal.

Se não for definido, source_credential tem de ter essa função em target_principal.
quota_project_id str | None

O ID do projeto usado para a quota e a faturação.

Nota: este projeto pode ser diferente do projeto usado para criar as credenciais.

Devoluções

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

Tipo devolvido

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

Obtém as credenciais da conta de serviço de curta duração do inquilino do SIEM da instância do Google SecOps.

Parâmetros

Parâmetros
chronicle_soar TIPCommon.types.ChronicleSOAR

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

Os âmbitos a pedir durante a concessão de autorização.
quota_project_id str | None

O ID do projeto usado para a quota e a faturação.

Nota: este projeto pode ser diferente do projeto usado para criar as credenciais.

Devoluções

Credenciais de conta de serviço de curta duração do inquilino do SIEM.

Tipo devolvido

impersonated_credentials.Credentials

class TIPCommon.rest.gcp.GcpErrorReason

classe TIPCommon.rest.gcp.GcpErrorReason

Bases: object

O espaço de nomes das constantes Google Cloud Error Reason.

Constantes

  • IAM_PERMISSION_DENIED = 'IAM_PERMISSION_DENIED'

class TIPCommon.rest.gcp.GcpPermissions

classe TIPCommon.rest.gcp.GcpPermissions

Bases: object

O espaço de nomes das 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 email da conta de serviço.

Parâmetros

Parâmetros
service_account_email str

O email da conta de serviço.

Devoluções

O ID do projeto.

Tipo devolvido

str

Aumenta

NotFoundError – Quando não consegue analisar o nome do projeto a partir do email da conta de serviço.

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.

Devoluções

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

Tipo devolvido

str

Aumenta

NotFoundError – Quando não consegue 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

Obtém um Google Cloud cliente HTTP autorizado.

Parâmetros

Parâmetros
credentials service_account.Credentials

Um objeto Google Cloud Credentials.
verify_ssl bool, opcional

Valida o certificado SSL. A predefinição é True.

Devoluções

O cliente HTTP autorizado.

Tipo devolvido

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

Obtém o email da conta de serviço da carga de trabalho do Google Cloud servidor de metadados.

Parâmetros

Parâmetros
default_sa_to_return str | None

Conta de serviço predefinida a devolver se não for encontrada.

A predefinição é None.

Devoluções

O email da conta de serviço da carga de trabalho.

Tipo devolvido

str

Aumenta

GoogleCloudException – Quando não é possível obter o email da conta de serviço da carga de trabalho da 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

Obtém o ID do projeto a partir de um email de uma conta de serviço ou de uma identidade da carga de trabalho.

Parâmetros

Parâmetros
user_service_account SingleJson | None

O JSON da conta de serviço do utilizador.
service_account_email str | None

O email do Workload Identity.
default_project_id str | None

O ID do projeto predefinido a devolver se não for encontrado.

Se for fornecido, esta função não gera NotFoundError.

A predefinição é None.

Devoluções

O ID do projeto do email da conta de serviço ou da identidade da carga de trabalho. Se não for encontrado, devolve None.

Tipo devolvido

str | None

Aumenta

NotFoundError – Quando não é possível analisar o nome do projeto a partir do email 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 simulação da conta de serviço a partir de uma resposta autorizada HTTP.

Parâmetros

Parâmetros
content dict

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

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

A predefinição é "Service Account Impersonation failed".

Devoluções

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

Tipo devolvido

None

Aumenta

ImpersonationUnauthorizedError: quando a simulaçã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 Google Cloud API de recursos.

Parâmetros
service_account str | dict

Uma Google Cloud conta de serviço do projeto com as funções de gestão de identidade e de acesso necessárias.
audience str

O Google Cloud âmbito.
verify_ssl bool

Define se deve criar uma sessão com encriptação SSL.

Devoluções

Um objeto de sessão autorizado.

Tipo devolvido

requests.Session

Aumenta

ValueError: quando não são fornecidas credenciais nem uma conta de serviço.

exception TIPCommon.rest.soar_api.SoarApiServerError

Bases: Exception

Erros das chamadas da API do SOAR do Google Security Operations 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 SOAR do Google Security Operations.
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.

Devoluções

Lista de objetos CustomFieldValue.

Tipo devolvido

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]

Obtém os eventos de um alerta específico.

Parâmetros

Parâmetros
chronicle_soar ChronicleSOAR

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

O ID do registo. 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.

Devoluções

O JSON da resposta do pedido. Uma lista de JSONs de eventos.

Tipo devolvido

list[SingleJson]

Aumenta

requests.HTTPError – Quando o servidor devolve um código de estado de não êxito. json.JSONDecodeError: quando o valor devolvido 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 registos.

Parâmetros

Parâmetros
chronicle_soar ChronicleSOAR

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

O ID do registo SOAR do Google Security Operations.

Devoluções

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

Tipo devolvido

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

Obtenha detalhes da vista geral do registo através do ID do registo.

Parâmetros
chronicle_soar ChronicleSOAR

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

O ID do registo SOAR do Google Security Operations.

Devoluções

O objeto de detalhes do registo.

Tipo devolvido

(CaseDetails)

Aumenta

requests.HTTPError - Quando um pedido falha ou o estado do pedido 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]

Obtém todos os cartões de conetor.

Parâmetros

Parâmetros
chronicle_soar ChronicleSOAR

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

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

O ID do conetor.

Devoluções

Uma lista de todos os cartões de conetor.

Tipo devolvido

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]

Obtém dados de entidades.

Parâmetros

Parâmetros
chronicle_soar ChronicleSOAR

Um objeto do SDK SOAR do Google Security Operations.
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 registo.
case_distribution_type int

O tipo de distribuição de registos.

Devoluções

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

Tipo devolvido

dict

Aumenta

requests.HTTPError – Quando o servidor devolve um código de estado de não ê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]]

Obtém uma lista de ficheiros de definição de ações de ambiente.

Parâmetros
chronicle_soar ChronicleSOAR

Um objeto do SDK Google SecOps.

Devoluções

Uma lista de objetos SingleJson que representam os ficheiros de definição de ações.

Tipo devolvido

(list[SingleJson])

Aumenta

requests.HTTPError - Quando o servidor devolve um código de estado de não êxito. json.JSONDecodeError – Quando o valor devolvido 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 registos de federação.

Parâmetros

Parâmetros
chronicle_soar ChronicleSOAR

Um objeto do SDK SOAR do Google Security Operations.

Devoluções

JSON de resposta.

Tipo devolvido

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]

Obtém os detalhes completos do registo.

Parâmetros

Parâmetros
chronicle_soar ChronicleSOAR

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

O ID do registo SOAR do Google Security Operations.

Devoluções

Um mapeamento mutável que representa os detalhes completos do registo.

Tipo devolvido

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]

Obtém todas as integrações instaladas para os ambientes fornecidos.

Parâmetros

Parâmetros
chronicle_soar ChronicleSOAR

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

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

O ID da integração.

Devoluções

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

Tipo devolvido

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

Obtém uma lista de ficheiros de definição de ações de ambiente.

Parâmetros
chronicle_soar ChronicleSOAR

Um objeto do SDK Google SecOps.

Devoluções

Uma lista de objetos SingleJson que representam os ficheiros de definição de ações.

Tipo devolvido

(list[SingleJson])

Aumenta

requests.HTTPError - Quando o servidor devolve um código de estado de não êxito. json.JSONDecodeError – Quando o valor devolvido 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]

Obtém o ficheiro de detalhes completo da integração.

Parâmetros
chronicle_soar ChronicleSOAR

Um objeto do SDK Google SecOps.
integration_identifier str

O ID da integração.

Devoluções

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

Tipo devolvido

(SingleJSON)

Aumenta

requests.HTTPError - Quando o servidor devolve um código de estado de não êxito. json.JSONDecodeError – Quando o valor devolvido 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]

Obtém cartões de perfil de utilizador por página e filtro.

Parâmetros

Parâmetros
chronicle_soar ChronicleSOAR

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

Os termos de pesquisa.
requested_page int

O deslocamento inicial para devolver a página de um utilizador.
page_size int

O número de utilizadores a devolver.
filter_by_role bool

Defina se quer filtrar por função.
filter_disabled_users bool

Defina se quer filtrar utilizadores desativados.
filter_support_users bool

Defina se quer filtrar os utilizadores do apoio técnico.
fetch_only_support_users bool

Defina se pretende devolver apenas utilizadores de apoio técnico.
filter_permission_types list[int] | None

Uma lista de tipos de autorizações de filtros (por exemplo, 0).

Devoluções

A resposta do servidor SOAR: o cartão do perfil do utilizador.

Tipo devolvido

SingleJson

Aumenta

requests.HTTPError – Quando o servidor devolve um código de estado de não êxito. json.JSONDecodeError – Quando o valor devolvido não é um JSON válido.

Exemplo

Um exemplo do 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]

Obtém um cartão de instância de fluxo de trabalho.

Parâmetros

Parâmetros
chronicle_soar ChronicleSOAR

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

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

O ID do alerta SOAR do Google Security Operations.

Devoluções

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

Tipo devolvido

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]

Obtém valores de campos personalizados para um registo ou um alerta.

Parâmetros

Parâmetros
chronicle_soar ChronicleSOAR

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

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

Devoluções

O objeto de detalhes do registo.

Tipo devolvido

list[CustomFieldValue]

Aumenta

requests.HTTPError – Quando o pedido falha ou o estado do pedido 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]

Apresenta campos personalizados.

Parâmetros

Parâmetros
chronicle_soar ChronicleSOAR

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

O valor do filtro para a pesquisa.

Devoluções

O objeto de detalhes do registo.

Tipo devolvido

list[CustomField]

Aumenta

requests.HTTPError – Quando o pedido falha ou o estado do pedido 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 etiqueta de capa.

Parâmetros

Parâmetros
chronicle_soar ChronicleSOAR

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

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

Uma etiqueta a remover.
alert_identifier str | None

O ID do alerta {google_secops_soar_name}.

Devoluções

Nenhum.

Tipo devolvido

None

Aumenta

requests.HTTPError – Quando o servidor devolve um código de estado de não ê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 um ficheiro diretamente na parede da caixa.

Parâmetros

Parâmetros
chronicle_soar ChronicleSOAR

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

Um objeto CaseWallAttachment.

Devoluções

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

Tipo devolvido

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 SOAR do Google Security Operations.
case_id int

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

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

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

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

Devoluções

Nenhum.

Tipo devolvido

None

Aumenta

requests.HTTPError – Quando o servidor devolve um código de estado de não ê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]

Define pontuações de casos em massa.

Parâmetros

Parâmetros
chronicle_soar ChronicleSOAR

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

Um ID do registo SOAR do Google Security Operations para o mapeamento de pontuações.

Devoluções

Um JSON de resposta que contém o estado de êxito e, se aplicável, listas de casos com falhas.

Tipo devolvido

MutableMapping[str, Any]

Aumenta

requests.HTTPError – Quando o servidor devolve um código de estado de não êxito.

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 SOAR do Google Security Operations.
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 definir.

Devoluções

Um objeto CustomFieldValue.

Tipo devolvido

CustomFieldValue

TIPCommon.rest.soar_api.validate_response

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

Valida a resposta e devolve-a como JSON.

Parâmetros
response requests.Response

A resposta a validar.

Aumenta

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

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