Skip to main content

Objects

Relation between the company ID and the target IDs

This table shows possible combinations between companyId and targetIds default values, and how they affect creation of new user accounts.

companyId value

targetIds value

Result

Not set

Not set

The new account is linked to the same company and targets as the user who created the API key.

Not set

Valid IDs

The new account is linked to the same company as the user who created the API key, but it is able to access only the targets with the IDs specified in the targetIds parameter. Validations occur on targets.

Valid ID

Not set

The new account is linked to the company with the ID specified in the request. The target will be automatically set to the root of that company.

Valid ID

Valid ID

The new account is linked to the company with the specified ID and it is able to access only the targets with the specified IDs. Validations occur on both company ID and target IDs.

Notifications Visibility Options

You can use the visibilitySettings object to configure where notifications are visible. These are the available options:

Visibility option

Optional

Value

showInConsole

Yes

True to display this notification in Control Center, False otherwise. If no value is specified it will be set to its previous value or False if a aprevious value was not set.

sendPerEmail

Yes

True to send this notification by email, False otherwise. If no value is specified it will be set to its previous value or False if a previous value was not set.

This option will take effect only if a SMTP server is configured in the Configuration page of Control Center.

useCustomEmailDistribution

Yes

True to send email notification to a custom emailing list, False otherwise. The notification will be sent by email to the distribution list only.

If this option is set to True the sendPerEmail parameter must be specified and set to True.

If no value is specified it will be set to its previous value or False if a aprevious value was not set.

emails

Yes

(unless useCustomEmailDistribution exists and is set to True)

A list of email addresses to receive the notification via email. When set, only these email addresses receive the notification. When useCustomEmailDistribution is set to True, this list must contain at least one valid email address.

setCustomEmailSubject

Yes

Boolean, if True, default notification email subject lines will contain the text from the emailSubject field. If False, the default email subject line will be used.

Note

This option is only available for the 1,12, 16, 17, 21, 18, 19, 20, 22, 23, 25, 26, 29, and 31 notification types.

emailSubject

Yes

(unless setCustomEmailSubject exists and is set to True)

String, contains the custom text to be used as a subject line for notification emails.

Note

This option is only available for the 1,12, 16, 17, 21, 18, 19, 20, 22, 23, 25, 26, 29, and 31 notification types.

  • At least one visibility option from showInConsole, sendPerEmail must be set to True when the notification is enabled.

  • The sendPerEmail, useCustomEmailDistribution and emails visibility options are not available for these notification types:

    • 22 - Product Modules Event

Relation Between Notification Type and configurationSettings

Notification type

Available configurationSettings items with their type and possible values

1 - Malware Outbreak

  • useThreshold, boolean, True to trigger this notification when the number of infected managed network objects exceeds a custom threshold, False otherwise

  • threshold, integer, the percentage of managed network objects infected by the same malware. Valid values are between 1 and 100

2 - License Expires

  • receiveForChildCompany, boolean, True to receive the notification for a child company, False otherwise

4 - License Limit Is About To Be Reached

  • receiveForChildCompany, boolean, True to receive the notification for a child company, False otherwise

5 - Update Available

  • showConsoleUpdate, boolean, True to receive the notification for console updates, False otherwise

  • showPackageUpdate, boolean, True to receive the notification for package updates, False otherwise

  • showProductUpdate, boolean, True to receive the notification for product updates, False otherwise

9 - Exchange License Usage Limit Has Been Reached

  • receiveForChildCompany, boolean, True to receive the notification for a child company, False otherwise.

10 - Invalid Exchange User Credentials

  • receiveForChildCompany, boolean, True to receive the notification for a child company, False otherwise

11 - Upgrade Status

The configurationSettings parameter should not be set for this notification.

13 - Authentication Audit

  • receiveForChildCompany, boolean, True to receive the notification for a child company, False otherwise

17 - Antipshising Event

  • receiveForChildCompany, boolean, True to receive the notification for a child company, False otherwise

18 - Firewall Event

  • receiveForChildCompany, boolean, True to receive the notification for a child company, False otherwise

19 - ATC/IDS event

  • receiveForChildCompany, boolean, True to receive the notification for a child company, False otherwise

20 - User Control Event

  • receiveForChildCompany, boolean, True to receive the notification for a child company, False otherwise

21 - Data Protection Event

  • receiveForChildCompany, boolean, True to receive the notification for a child company, False otherwise

22 - Product Modules Event

  • receiveForChildCompany, boolean, True to receive the notification for a child company, False otherwise

23 - Security Server Status Event

  • receiveForChildCompany, boolean, True to receive the notification for a child company, False otherwise

  • notUpdated, boolean, True to receive the notification when the Security Server is outdated, False otherwise

  • reboot, boolean, True to receive the notification when the Security Server needs a reboot, False otherwise

  • stopped, boolean, True to receive the notification when the Security Server was powered off, False otherwise

25 - Overloaded Security Server Event

  • receiveForChildCompany, boolean, True to receive the notification for a child company, False otherwise

  • useThreshold, boolean, True to receive the notification when the scan load exceeds a custom threshold, False otherwise

  • threshold, integer, the minimum scan load necessary to issue this notification. Valid values are between 1 and 100

26 - Task Status

  • statusThreshold, integer, the task status which triggers this notification. Set to 2 for any status, 3 for failed tasks

27 - Outdated Update Server

  • receiveForChildCompany, boolean, True to receive the notification for a child company, False otherwise

32 - Amazon EC2 Trial Expires in 7 Days

The configurationSettings parameter should not be set for this notification.

33 - Amazon EC2 Trial Expires Tomorrow

The configurationSettings parameter should not be set for this notification.

34 - Amazon EC2 Licensing event

The configurationSettings parameter should not be set for this notification.

35 - Amazon EC2 Cancelation event

The configurationSettings parameter should not be set for this notification.

36 - Amazon EC2 Invalid credentials

The configurationSettings parameter should not be set for this notification.

Note

Notification types 32, 33, 34, 35 and 36 require an active Amazon EC2 integration with Control Center.

In this section: