Harmony Mobile

Integration version: 4.0

Use Cases

  1. Perform enrichment of entities
  2. Ingestion of alerts

How to generate Client ID and Client Secret

  1. Navigate to "Harmony Endpoint" section
  2. Go to "Global Settings"
  3. Go to "API Keys" section
  4. Press on the "New" button.
  5. Select "Harmony Mobile" Service and "Read-Only" role
  6. Copy "Client ID" and "Client Secret". Put those parameters into integrationconfiguration.

Configure Harmony Mobile integration on Google Security Operations

For detailed instructions on how to configure an integration inGoogle SecOps, seeConfigureintegrations.

Integration parameters

Use the following parameters to configure the integration:

Parameter Display NameTypeDefault ValueIs MandatoryDescription
API RootStringhttps://cloudinfra-gw.portal.checkpoint.comYesAPI root of the Harmony Mobile instance.
Client IDStringN/AYesClient ID of the Harmony Mobile account.
Client SecretPasswordN/AYesClient Secret of the Harmony Mobile account.
Verify SSLCheckboxCheckedYesIf enabled, verifies that the SSL certificate for the connection to the Harmony Mobile server is valid.
Note: You can make changes at a later stage if needed. Once configured, theInstances can be used in Playbooks. For detailed information on configuring andsupporting multiple instances, please seeSupporting multiple instances.

Actions

Ping

Description

Test connectivity to the Harmony Mobile with parameters provided at theintegration configuration page in the Google Security Operations Marketplace tab.

Parameters

N/A

Run On

This action doesn't run on entities.

Action Results

Script Result
Script Result NameValue Options
is_successis_success=False
is_successis_success=True
Case Wall
Result TypeValue / DescriptionType
Output message*

The action should not fail nor stop a playbook execution:
if successful: "Successfully connected to the Harmony Mobile server with the provided connection parameters!"

The action should fail and stop a playbook execution:
if not successful: "Failed to connect to the Harmony Mobile server! Error is {0}".format(exception.stacktrace)

General

Enrich Entities

Description

Enrich entities using information from Harmony Mobile. Supported entities:Hostname.

Note: Hostname entity should contain the "name" of the device.

Parameters

Parameter Display NameTypeDefault ValueIs MandatoryDescription
Create InsightCheckboxCheckedNoIf enabled, action will create an insight containing all of the retrieved information about the entity.

Run On

This action runs on the Hostname entity.

Action Results

Script Result
Script Result NameValue Options
is_successis_success=False
is_successis_success=True
JSON Result
{"client_version":"3.8.6.4637","device_type":"Android","email":"dana@example.com","internal_id":1,"last_connection":"Wed, 14 Jul 2021 05:26:09 +0000","mail_sent":true,"mdm":null,"model":"HUAWEI / HUAWEI GRA-L09","name":"Dana Doe","number":"+11","os_type":"Android_4_x","os_version":"6.0","risk":"No Risk","status":"Active"}
Entity Enrichment
Enrichment Field NameLogic - When to apply
client_versionWhen available in JSON
device_typeWhen available in JSON
emailWhen available in JSON
last_connectionWhen available in JSON
modelWhen available in JSON
nameWhen available in JSON
numberWhen available in JSON
os_typeWhen available in JSON
os_versionWhen available in JSON
riskWhen available in JSON
statusWhen available in JSON
Insights

Example of entityinsight

Case Wall
Result typeValue/DescriptionType
Output message

The action should not fail nor stop a playbook execution:
if data is available for one(is_success = true): "Successfully enriched the following entities using information from Harmony Mobile: {entity.identifier}".

If data is not available for one (is_success=true): "Action wasn't able to enrich the following entities using information from Harmony Mobile: {entity.identifier}".

If data is not available for all (is_success=false): None of the provided entities were enriched.

The action should fail and stop a playbook execution:
if fatal error, like wrong credentials, no connection to server, other: "Error executing action "Enrich Entities". Reason: {0}''.format(error.Stacktrace)

General

Case Wall Table

Title: {entity.identifier}Entity

Connector

Harmony Mobile - Alerts Connector

Description

Pull information about alerts from Harmony Mobile. Note: whitelist filter workswith "alertEvent" parameter.

Configure Harmony Mobile - Alerts Connector in Google SecOps

For detailed instructions on how to configure a connector inGoogle SecOps, seeConfiguring theconnector.

Connector parameters

Use the following parameters to configure the connector:

Parameter Display NameTypeDefault ValueIs MandatoryDescription
Product Field NameStringProduct NameYesEnter the source field name in order to retrieve the Product Field name.
Event Field NameStringalertTypeYesEnter the source field name in order to retrieve the Event Field name.
Environment Field NameString""No

Describes the name of the field where the environment name is stored.

If the environment field isn't found, the environment is the default environment.

Environment Regex PatternString.*No

A regex pattern to run on the value found in the "Environment Field Name" field.

Default is .* to catch all and return the value unchanged.

Used to allow the user to manipulate the environment field via regex logic.

If the regex pattern is null or empty, or the environment value is null, the final environment result is the default environment.

Script Timeout (Seconds)Integer180YesTimeout limit for the python process running the current script.
API RootStringhttps://cloudinfra-gw.portal.checkpoint.comYesAPI root of the Harmony Mobile instance.
Client IDStringN/AYesClient ID of the Harmony Mobile account.
Client SecretPasswordN/AYesClient Secret of the Harmony Mobile account.
Lowest Risk To FetchIntegerFalseLowest risk that needs to be used to fetch alerts. Possible values: Informational, Low, Medium, High. If nothing is specified, the connector will ingest alerts with all risk levels.
Max Hours BackwardsInteger1NoAmount of hours from where to fetch alerts.
Max Alerts To FetchInteger100NoHow many alerts to process per one connector iteration. Default: 100.
Use whitelist as a blacklistCheckboxUncheckedYesIf enabled, whitelist will be used as a blacklist.
Verify SSLCheckboxCheckedYesIf enabled, verifies that the SSL certificate for the connection to the Harmony Mobile server is valid.
Proxy Server AddressStringN/ANoThe address of the proxy server to use.
Proxy UsernameStringN/ANoThe proxy username to authenticate with.
Proxy PasswordPasswordN/ANoThe proxy password to authenticate with.

Connector Rules

Proxy Support

The connector supports proxy.

Need more help?Get answers from Community members and Google SecOps professionals.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-02-19 UTC.