-
Notifications
You must be signed in to change notification settings - Fork 27
/
demistomock.py
1046 lines (832 loc) · 30.5 KB
/
demistomock.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
from __future__ import print_function
import json
import logging
import uuid
integrationContext = {}
is_debug = False # type: bool
exampleIncidents = [
{
"Brand": "Builtin",
"Category": "Builtin",
"Contents": {
"data": [
{
"CustomFields": {},
"account": "",
"activated": "0001-01-01T00:00:00Z",
"attachment": None,
"autime": 1550670443962164000,
"canvases": None,
"category": "",
"closeNotes": "",
"closeReason": "",
"closed": "0001-01-01T00:00:00Z",
"closingUserId": "",
"created": "2019-02-20T15:47:23.962164+02:00",
"details": "",
"droppedCount": 0,
"dueDate": "2019-03-02T15:47:23.962164+02:00",
"hasRole": False,
"id": "1",
"investigationId": "1",
"isPlayground": False,
"labels": [
{"type": "Instance", "value": "test"},
{"type": "Brand", "value": "Manual"},
],
"lastOpen": "0001-01-01T00:00:00Z",
"linkedCount": 0,
"linkedIncidents": None,
"modified": "2019-02-20T15:47:27.158969+02:00",
"name": "1",
"notifyTime": "2019-02-20T15:47:27.156966+02:00",
"occurred": "2019-02-20T15:47:23.962163+02:00",
"openDuration": 0,
"owner": "analyst",
"parent": "",
"phase": "",
"playbookId": "playbook0",
"previousRoles": None,
"rawCategory": "",
"rawCloseReason": "",
"rawJSON": "",
"rawName": "1",
"rawPhase": "",
"rawType": "Unclassified",
"reason": "",
"reminder": "0001-01-01T00:00:00Z",
"roles": None,
"runStatus": "waiting",
"severity": 0,
"sla": 0,
"sourceBrand": "Manual",
"sourceInstance": "amichay",
"status": 1,
"type": "Unclassified",
"version": 6,
}
],
"total": 1,
},
"ContentsFormat": "json",
"EntryContext": None,
"Evidence": False,
"EvidenceID": "",
"File": "",
"FileID": "",
"FileMetadata": None,
"HumanReadable": None,
"ID": "",
"IgnoreAutoExtract": False,
"ImportantEntryContext": None,
"Metadata": {
"brand": "Builtin",
"category": "",
"contents": "",
"contentsSize": 0,
"created": "2019-02-24T09:44:51.992682+02:00",
"cronView": False,
"endingDate": "0001-01-01T00:00:00Z",
"entryTask": None,
"errorSource": "",
"file": "",
"fileID": "",
"fileMetadata": None,
"format": "json",
"hasRole": False,
"id": "",
"instance": "Builtin",
"investigationId": "7ab2ac46-4142-4af8-8cbe-538efb4e63d6",
"modified": "0001-01-01T00:00:00Z",
"note": False,
"parentContent": '!getIncidents query="id:1"',
"parentEntryTruncated": False,
"parentId": "111@7ab2ac46-4142-4af8-8cbe-538efb4e63d6",
"pinned": False,
"playbookId": "",
"previousRoles": None,
"recurrent": False,
"reputationSize": 0,
"reputations": None,
"roles": None,
"scheduled": False,
"startDate": "0001-01-01T00:00:00Z",
"system": "",
"tags": None,
"tagsRaw": None,
"taskId": "",
"times": 0,
"timezoneOffset": 0,
"type": 1,
"user": "",
"version": 0,
},
"ModuleName": "InnerServicesModule",
"Note": False,
"ReadableContentsFormat": "",
"System": "",
"Tags": None,
"Type": 1,
"Version": 0,
}
]
exampleContext = [
{
"Brand": "Builtin",
"Category": "Builtin",
"Contents": {
"context": {},
"id": "1",
"importantKeys": None,
"modified": "2019-02-24T09:50:21.798306+02:00",
"version": 30,
},
"ContentsFormat": "json",
"EntryContext": None,
"Evidence": False,
"EvidenceID": "",
"File": "",
"FileID": "",
"FileMetadata": None,
"HumanReadable": None,
"ID": "",
"IgnoreAutoExtract": False,
"ImportantEntryContext": None,
"Metadata": {
"brand": "Builtin",
"category": "",
"contents": "",
"contentsSize": 0,
"created": "2019-02-24T09:50:28.652202+02:00",
"cronView": False,
"endingDate": "0001-01-01T00:00:00Z",
"entryTask": None,
"errorSource": "",
"file": "",
"fileID": "",
"fileMetadata": None,
"format": "json",
"hasRole": False,
"id": "",
"instance": "Builtin",
"investigationId": "7ab2ac46-4142-4af8-8cbe-538efb4e63d6",
"modified": "0001-01-01T00:00:00Z",
"note": False,
"parentContent": '!getContext id="1"',
"parentEntryTruncated": False,
"parentId": "120@7ab2ac46-4142-4af8-8cbe-538efb4e63d6",
"pinned": False,
"playbookId": "",
"previousRoles": None,
"recurrent": False,
"reputationSize": 0,
"reputations": None,
"roles": None,
"scheduled": False,
"startDate": "0001-01-01T00:00:00Z",
"system": "",
"tags": None,
"tagsRaw": None,
"taskId": "",
"times": 0,
"timezoneOffset": 0,
"type": 0,
"user": "",
"version": 0,
},
"ModuleName": "InnerServicesModule",
"Note": False,
"ReadableContentsFormat": "",
"System": "",
"Tags": None,
"Type": 0,
"Version": 0,
}
]
exampleUsers = [
{
"Brand": "Builtin",
"Category": "Builtin",
"Contents": [
{
"accUser": False,
"addedSharedDashboards": None,
"canPostTicket": False,
"dashboards": None,
"defaultAdmin": True,
"disableHyperSearch": False,
"editorStyle": "",
"email": "[email protected]",
"helpSnippetDisabled": False,
"homepage": "",
"id": "admin",
"image": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAJAAAACQCAYAAADnRuK4AAAACXBIWXMAAB"
"YlAAAWJQFJUiTwAAAFeElEQVR42u2dO1MbVxSAj2whIZAQHlWksSrcwKAMVWjYNLhiRjOkSYXyC7"
"z5BfE/iNKmYWlchRnNyE2oRKO0y5DGaiI3pokcbRYNelopCDNOeGmlXS269/v6BcH9dPace+4jM"
"hwOhwIwJk/4FwACAQIBAgECASAQIBAgECAQAAIBAgECAQIBIBAgECAQIBAAAgECAQIBAgECASAQIB"
"AgECAQAAIBAgECAQIBIBAEQfSxfJBK74NY7ZrYg4ac9huMzD1sRDOSj2XFTKzLciQW6meJhH3AlN1"
"viNmqyknvHDM8ko7E5PXCppiJdT0Fsto1+e6iggkTsh9fFStl6JUDIY9/HHZqUrw80ycC2f2GGE5Zn"
"GGX0feRP559K9mnKfUjkNmqIk8AFNvTj0JTF8juN0iYA6LUqasvkNV5x0gHxPtPF1P/nVOfB7IfmON"
"JR2JSWtoRY+6LmR/QgluRw05NaWmnHoEeen1ZKWPm5WkOu1rIE0oEeoh8LDvz8hhOWZvZdHphyINAyI"
"NAyEMOpCe6z6oTgZCHCCRy1Zy1Ou9uTBNsz61IIf5CCvOryINAN6kPXMm7x3fmHye9cznpnUuxfSal1I"
"4vzUbkUeQVVh+4kmsejZS8nvYbkmseSX3gThzpvmweIY8KAuXdY08D6Qy7knePJ5KHNUyKCGS1a2OVza"
"f9hljtGvJoL9AEXX2vzyKPgkn0JGuKvDxrtqry0+XvmKJiDjQNkAeBAIEAgXxme24llGdBEYEK8RehPAu"
"qCDS/KhvRjOfnNqIZ3/tiCDSjlFI7kvZwuEA6EpNSaodRR6Arsk9TYi/vjRSJNqIZsZf3pr5zE4FmRKK"
"DpHFrcrw9tyIHSQN5AkKZ9UCF+VVyGyIQIBAgEAACAQIBAgECASAQIBAg0AiUunVGBYHu5qHFXAW3IpX"
"eB0ZmRph6LywXzdy7K8IZduVr5y0jQwS6I8KwGjAw0iFcvDJ1gXLRDGuSAyKMw0lDSaKLi1uhfFtUx0"
"ys6SFQLpqR4uIWI+4j+/FVfSKQyNUCsIOkwcj7wEY0I8VkOF9ILpybcV4l1kKN5qELdA1XXo7O8ydJ"
"ycezYs6vh77O+9EI9FiJ/PnzxK+XSno39LtNlcuBdEls7eU9ZeUR4ZzowDhIGlrsEkEgn1HpuioEC"
"qGc9usoYXIgDfOdSnpXu92vRCAf+GFhU14vbGr5tyPQhPmOlTJm/pI8BAqB50+SUlp6KbkxzihCIM"
"3ZnluR0tJLped3SKID4lViTemZZSJQgOgyOYhAASTLlfSu9vkOAnmkOewq3wydFLrxQBINCAQIBAik"
"CXa/IdmPb8a6ufAhrHZNsh/fiK3JslztkujmsCu5v36R958uRETkx8WvxEys+/Kzi5dn8n3rNxG5"
"anXYz75RvnrTSqDmsCuGU76xaH8/vipWypjoZxfcihx2/hvRdJgC0OoVZl5Ub93xcdipieGUpTnG"
"Vd7XUv5fHpGrC37Niyo5kBLytKq3DvI1J71zMZyyp3vl6wNXDKd87562w05NzJa6EmnxCvNy6/Ko"
"bQu73xDDKY98b72qfTQtIlAumhn5MAfn31fSfRWa1a55kicdiSnbR9Mmia4PXMm7x552vd5WoX1"
"eaY2C6gvttavC8n//6mkf/ucV2m2V1n3osPBMy2bqOCJcJ9rjiKcy2nbjvb6KvODn5CQCPfLqzGx"
"R06GR0mWi4tbWq1a1H49kNdyfNLyH4Go0LSrtBAooApNl0oLgQKq0HSptBAogApNp0oLgXys0HSst"
"BDIpwqN/WEINHaFJiLaVloI5EOFJiJsLkQg8Bu29QACAQIBAgECASAQIBAgECAQAAIBAgECAQIBIB"
"AgECAQIBAAAgECAQLBLPMPFxalhUpzvrEAAAAASUVORK5CYII=",
# noqa E501
"investigationPage": "",
"lastLogin": "0001-01-01T00:00:00Z",
"name": "Admin Dude",
"notify": ["mattermost", "email", "slack"],
"phone": "+650-123456",
"playgroundCleared": False,
"playgroundId": "818df1a9-98dc-46df-84dc-dbd2fffc0fda",
"preferences": {
"userPreferencesIncidentTableQueries": {
"Open Jobs in the last 7 days": {
"picker": {
"predefinedRange": {"id": "7", "name": "Last 7 days"}
},
"query": "-status:closed category:job",
},
"Open incidents in the last 7 days": {
"isDefault": True,
"picker": {
"predefinedRange": {"id": "7", "name": "Last 7 days"}
},
"query": "-status:closed -category:job",
},
},
"userPreferencesWarRoomFilter": {
"categories": [
"chats",
"incidentInfo",
"commandAndResults",
"notes",
],
"fromTime": "0001-01-01T00:00:00Z",
"pageSize": 0,
"tagsAndOperator": False,
"usersAndOperator": False,
},
"userPreferencesWarRoomFilterExpanded": False,
"userPreferencesWarRoomFilterMap": {
"Chats only": {
"categories": ["chats"],
"fromTime": "0001-01-01T00:00:00Z",
"pageSize": 0,
"tagsAndOperator": False,
"usersAndOperator": False,
},
"Default Filter": {
"categories": [
"chats",
"incidentInfo",
"commandAndResults",
"notes",
],
"fromTime": "0001-01-01T00:00:00Z",
"pageSize": 0,
"tagsAndOperator": False,
"usersAndOperator": False,
},
"Playbook results": {
"categories": [
"playbookTaskResult",
"playbookErrors",
"justFound",
],
"fromTime": "0001-01-01T00:00:00Z",
"pageSize": 0,
"tagsAndOperator": False,
"usersAndOperator": False,
},
},
"userPreferencesWarRoomFilterOpen": True,
},
"roles": {"demisto": ["Administrator"]},
"theme": "",
"username": "admin",
"wasAssigned": False,
}
],
"ContentsFormat": "json",
"EntryContext": {
"DemistoUsers": [
{
"email": "[email protected]",
"name": "Admin Dude",
"phone": "+650-123456",
"roles": ["demisto: [Administrator]"],
"username": "admin",
}
]
},
"Evidence": False,
"EvidenceID": "",
"File": "",
"FileID": "",
"FileMetadata": None,
"HumanReadable": "## Users\nUsername|Email|Name|Phone|Roles\n-|-|-|-|-\nadmin|[email protected]|Admin Dude|"
"\\+650-123456|demisto: \\[Administrator\\]\n",
# noqa E501
"ID": "",
"IgnoreAutoExtract": False,
"ImportantEntryContext": None,
"Metadata": {
"brand": "Builtin",
"category": "",
"contents": "",
"contentsSize": 0,
"created": "2019-02-24T09:50:28.686449+02:00",
"cronView": False,
"endingDate": "0001-01-01T00:00:00Z",
"entryTask": None,
"errorSource": "",
"file": "",
"fileID": "",
"fileMetadata": None,
"format": "json",
"hasRole": False,
"id": "",
"instance": "Builtin",
"investigationId": "7ab2ac46-4142-4af8-8cbe-538efb4e63d6",
"modified": "0001-01-01T00:00:00Z",
"note": False,
"parentContent": '!getUsers online="False"',
"parentEntryTruncated": False,
"parentId": "120@7ab2ac46-4142-4af8-8cbe-538efb4e63d6",
"pinned": False,
"playbookId": "",
"previousRoles": None,
"recurrent": False,
"reputationSize": 0,
"reputations": None,
"roles": None,
"scheduled": False,
"startDate": "0001-01-01T00:00:00Z",
"system": "",
"tags": None,
"tagsRaw": None,
"taskId": "",
"times": 0,
"timezoneOffset": 0,
"type": 1,
"user": "",
"version": 0,
},
"ModuleName": "InnerServicesModule",
"Note": False,
"ReadableContentsFormat": "",
"System": "",
"Tags": None,
"Type": 1,
"Version": 0,
}
]
exampleDemistoUrls = {
"evidenceBoard": "https://test-address:8443/#/EvidenceBoard/7ab2ac46-4142-4af8-8cbe-538efb4e63d6",
"investigation": "https://test-address:8443/#/Details/7ab2ac46-4142-4af8-8cbe-538efb4e63d6",
"relatedIncidents": "https://test-address:8443/#/Cluster/7ab2ac46-4142-4af8-8cbe-538efb4e63d6",
"server": "https://test-address:8443",
"warRoom": "https://test-address:8443/#/WarRoom/7ab2ac46-4142-4af8-8cbe-538efb4e63d6",
"workPlan": "https://test-address:8443/#/WorkPlan/7ab2ac46-4142-4af8-8cbe-538efb4e63d6",
}
callingContext = {} # type: dict
def params():
"""(Integration only)
Retrieves the integration parameters object
Returns:
dict: Integrations parameters object
"""
return {}
def args():
"""Retrieves a command / script arguments object
Returns:
dict: Arguments object
"""
return {}
def command():
"""(Integration only)
Retrieves the integration command that is being run
Returns:
str: Integrations command name
"""
return ""
def log(msg):
"""Prints a message to the current incidents war room log
Args:
msg (str): The message to be logged
Returns:
None: No data returned
"""
logging.getLogger().info(msg)
def get(obj, field):
"""Extracts field value from nested object
Args:
obj (dict): The object to extract the field from
field (str): The field to extract from the object, given in dot notation
Returns:
str: The value of the extracted field
"""
parts = field.split(".")
for part in parts:
if obj and part in obj:
obj = obj[part]
else:
return None
return obj
def gets(obj, field):
"""Extracts field value from nested object
Args:
obj (dict): The object to extract the field from
field (str): The field to extract from the object, given in dot notation
Returns:
str: The value of the extracted field
"""
return str(get(obj, field))
def context():
"""Retrieves the context data object of the current incident
Returns:
dict: Context data object
"""
return {}
def uniqueFile():
"""Generate a unique file name based upon a random UUID
Returns:
str: Random UUID
"""
return str(uuid.uuid4())
def getLastRun():
"""(Integration only)
Retrieves the LastRun object
Returns:
dict: LastRun object
"""
return {"lastRun": "2018-10-24T14:13:20+00:00"}
def setLastRun(obj):
"""(Integration only)
Stores given object in the LastRun object
Args:
obj (dict): The object to store
Returns:
None: No data returned
"""
return None
def info(msg, *args):
"""Prints a message to the server logs in info level
Args:
msg (str): The message to be logged
args (dict): Additional arguments to log
Returns:
None: No data returned
"""
logging.getLogger().info(msg, *args)
def error(msg, *args):
"""Prints a message to the server logs in error level
Args:
msg (str): The message to be logged
args (dict): Additional arguments to log
Returns:
None: No data returned
"""
# print to stdout so pytest fail if not mocked
print(msg, *args)
def debug(msg, *args):
"""Prints a message to the server logs in debug level
Args:
msg (str): The message to be logged
args (dict): Additional arguments to log
Returns:
None: No data returned
"""
logging.getLogger().info(msg, *args)
def getAllSupportedCommands():
"""(Script only)
Retrieves all available integration commands and scripts
Returns:
dict: Object of all available integrations and scripts
"""
return {}
def results(results):
"""Outputs entries to the war-room
Args:
results (Union[list, dict]): The entry object or array of entry objects to output
Returns:
None: No data returned
"""
if type(results) is dict and results.get("contents"):
results = results.get("contents")
log("demisto results: {}".format(json.dumps(results, indent=4, sort_keys=True)))
def credentials(credentials):
"""(Integration only)
For integrations that support fetching credentials. Send the fetched credentials to the server.
Args:
credentials (list): List of credential objects
Returns:
None: No data returned
"""
log("credentials: {}".format(credentials))
def getFilePath(id):
"""Retrieves file path and name, given file entry ID
Args:
id (str): File entry ID to get details of
Returns:
dict: Object contains file ID, path and name
"""
return {'id': id, 'path': 'test/test.txt', 'name': 'test.txt'}
def investigation():
"""Retrieves the ID of the investigation in which being run in
Returns:
dict: Object contains the investigation ID
"""
return {"id": "1"}
def executeCommand(command, args):
"""(Script only)
Executes given integration command / script and arguments
Args:
command (str): Integration command name or script name to run
args (dict): Integration command / script arguments
Returns:
Union[dict, list]: Command execution response wrapped in Demisto entry object
"""
commands = {
"getIncidents": exampleIncidents,
"getContext": exampleContext,
"getUsers": exampleUsers,
}
if commands.get(command):
return commands.get(command)
return ""
def getParam(param):
"""(Integration only)
Extracts given parameter from the integration parameters object
Args:
param (str): Integration parameter to get value of
Returns:
str: Integration parameter value
"""
return params().get(param)
def getArg(arg):
"""Extracts given argument from the arguments object
Args:
arg (str): Argument to get value of
Returns:
str: Argument value
"""
return args().get(arg)
def setIntegrationContext(context):
"""(Integration only)
Stores given object in the IntegrationContext object
Args:
context (dict): The object to store
Returns:
None: No data returned
"""
global integrationContext
integrationContext = context
def getIntegrationContext():
"""(Integration only)
Retrieves the IntegrationContext object
Returns:
dict: IntegrationContext object
"""
return integrationContext
def setIntegrationContextVersioned(context, version=-1, sync=False):
"""(Integration only)
Stores given object in the IntegrationContext object in given version
Args:
context (dict): The object to store
version (int): The context version to set. If the version is older than the current, an error will be thrown. (Default value = -1) # noqa
sync (bool): Whether to save the context to the DB right away.
If false, the context will be saved at the end of the command. (Default value = False)
Returns:
None: No data returned
"""
global integrationContext
integrationContext = context
def getIntegrationContextVersioned(refresh=False):
"""(Integration only)
Retrieves the versioned IntegrationContext object
Args:
refresh (bool): Whether to get the integration context straight from the DB and not from the instance memory.
(Default value = False) # noqa
Returns:
dict: IntegrationContext versioned object
"""
return integrationContext
def incidents(incidents=None):
"""In script, retrieves the `Incidents` list from the context
In integration, used to return incidents to the server
Args:
incidents (list): In integration only, list of incident objects (Default value = None)
Returns:
list: List of incident objects
"""
if incidents is None:
return exampleIncidents[0]['Contents']['data']
else:
return results(
{"Type": 1, "Contents": json.dumps(incidents), "ContentsFormat": "json"}
)
def incident():
"""Retrieves the current incident
Returns:
dict: dict representing an incident object
"""
return incidents()[0]
def setContext(contextPath, value):
"""(Script only)
Sets given value in path in the context data
Args:
contextPath (str): The context data path to set the value in
value (str): The value to set in the context data path
Returns:
dict: Object contains operation result status
"""
return {"status": True}
def demistoUrls():
"""Retrieves the following URLs related to the incident.
- evidenceBoard
- investigation
- relatedIncidents
- server
- warRoom
- workPlan
You can use these URLs when you send notifications outside the system
over email or slack and would like to include a link to the incident.
Returns:
dict: Object contains server URLs with page as key and URL as value
"""
return exampleDemistoUrls
def dt(obj=None, trnsfrm=None):
"""Extracts field from object using DT language syntax
Args:
obj (dict): The object to look in for the requested field (Default value = None)
trnsfrm (str): The field to get value of (Default value = None)
Returns:
str: The field value in the object
"""
return ""
def addEntry(id, entry, username=None, email=None, footer=None):
"""(Integration only)
Adds an entry to a mirrored investigation war room
Args:
id (str): Incident ID to add the entry in
entry (str): The text to add in the entry
username (str): The username of the user to be the entry creator (Default value = None)
email (str): The email address of the user to be the entry creator (Default value = None)
footer (str): The email address of the user to be the entry creator (Default value = None)
Returns:
None: No data returned
"""
return ""
def mirrorInvestigation(id, mirrorType, autoClose=False):
"""(Integration only)
Marks an investigation as mirrored
Args:
id (str): Incident ID to mirror
mirrorType (str): Contains mirror type and mirror direction separated by colon, e.g. all:both
autoClose (bool): Whether to close the investigation when the mirrored channel is closed/archived
(Default value = False)
Returns:
None: No data returned
"""
return ""
def updateModuleHealth(error):
"""(Integration only)
Updated integration module health with given error message
Args:
error (str): The error message to display in the integration module health
Returns:
None: No data returned
"""
return ""
def directMessage(message, username=None, email=None, anyoneCanOpenIncidents=None):
"""(Integration only)
Executes command provided in direct message to messaging bot
Args:
message (str): The message sent in personal context
username (str): The username of the user that sent the direct message (Default value = None)
email (str): The email address of the user that sent the direct message (Default value = None)
anyoneCanOpenIncidents (bool): Whether external users can create incidents or not (Default value = None)
Returns:
str: Server response to command executed in the direct message
"""
return ""
def createIncidents(incidents, lastRun=None, userID=None):
"""(Integration only)
Creates incident in long running execution
Args:
incidents (list): List of incident objects to create, with the following optional keys:
- name (str)
- type (str) - If not provided, an Unclassified incident will be created
- labels (list) - List of {"type": _, "value": _} objects
- rawJSON (str) - Will be omitted after the classification & mapping step
- occurred (str)
- details (str)
- severity (int)
lastRun (dict): the LastRun object to set (Default value = None)
userID (str): The user associated with the request (Default value = None)
Returns:
Union[list, dict]: Created incident object
"""
return []
def findUser(username=None, email=None):
"""(Integration only)
Looks up for a user in the system
Args:
username (str): The username of the user to search for (Default value = None)
email (str): The email address of the user to search for (Default value = None)
Returns:
dict: Object representing the user found
"""
return {}
def handleEntitlementForUser(incidentID, guid, email, content, taskID=""):
"""(Integration only)
Sends request to server to process entitlement response given from messaging client
Args:
incidentID (str): The incident ID in which the question was sent in
guid (str): The entitlement UUID which identifies the question
email (str): The email address of the user that responded
content (str): The content of the response
taskID (str): The playbook task ID to mark as complete (Default value = "")
Returns:
None: No data returned
"""
return {}
def demistoVersion():
"""Retrieves server version and build number
Returns:
dict: Objects contains server version and build number
"""
return {
'version': '5.5.0',
'buildNumber': '12345'
}
def integrationInstance():
"""(Integration only)
Retrieves the integration instance name in which ran in
Returns:
str: The integration instance name
"""
return ""
def createIndicators(indicators_batch):
"""(Integration only)
Creates indicators from given indicator objects batch
Args:
indicators_batch (list): List of indicators objects to create
Returns:
None: No data returned
"""
return ""
def searchIndicators(fromDate='', query='', size=100, page=0, toDate='', value='', searchAfter=None):
"""Searches for indicators according to given query
Args:
fromdate (str): The start date to search from (Default value = '')
query (str): Indicator search query (Default value = '')
size (int): Limit the number of returned results (Default value = 100)
page (int): Response paging (Default value = 0)
todate (str): The end date to search until to (Default value = '')
value (str): The indicator value to search (Default value = '')