Related Concepts: Case Manipulation

This function adds a single tag to the current Siemplify case. A tag can then be later used to filter the case queue, search or dashboard widgets.

add_tag(tag)

Parameters:

Param Name Param Type Possible Values Comments Mandatory Parameter
tag string Any string to be used as a tag Length should be shorter than 250 characters Yes
case_id string Takes by default the ID of the context case
No
alert_identifier string Takes by default the ID of the context alert
No

Return Type

NoneType

Example:

Sample Code
from SiemplifyAction import SiemplifyAction
siemplify = SiemplifyAction()
tag_to_be_added = "MaliciousMail"
siemplify.add_tag(tag=tag_to_be_added)
Result Behavior
"MaliciousMail" tag is added to the current case. 
Result Value
None

NOTE: It is advised not to create tags that are too specific, as tags are used in the system to help search and filter cases. So, try to avoid using tags with entity identifiers or any other unique strings.
NOTE 2: Tags created either manually or by an action will not count for playbook trigger “By Tag”. For that, please refer to the “Case Tag” table in the Siemplify settings.