any_entity_in_custom_list
Related Concepts: Custom Lists
Given a list of CustomList objects that
represent lines from the
CustomList settings, and returns True
(Boolean) if any of them exists in the settings table. Otherwise, returns
False (Boolean)
Each parameter should be explicitly specified –
identifier, category and environment (all strings).
result_1 = siemplify.any_entity_in_custom_list([custom_list_1])
Parameters:
Param Name | Param Type | Possible Values | Comments | Mandatory Parameter |
---|---|---|---|---|
category_name | List | “CustomList” | the custom list category | Yes |
Return Type
Boolean
Example:
Here’s an example. Below, the state of the system is presented:
Sample Code
from SiemplifyAction import SiemplifyAction
siemplify = SiemplifyAction()
custom_list_1 = CustomList(identifier="GOOGLE.COM", category="WhiteListed HOSTs", environment="")
custom_list_2 = CustomList(identifier="GOOGLE.COM", category="WhiteListed HOSTs", environment="Other_Environment")
custom_list_3 = CustomList(identifier="GOOGLE.COM", category="BlackListed HOSTs", environment="")
result_1 = siemplify.any_entity_in_custom_list([custom_list_1]) # True
result_2 = siemplify.any_entity_in_custom_list([custom_list_2]) # False
result_3 = siemplify.any_entity_in_custom_list([custom_list_3]) # False
Result Behavior
In this example, _result_1_ equals True. _result_2_ and _result_3_ are False comparing to the system's state below.
System’s state
Result Value
True/False