/
CofenseVision.yml
2390 lines (2299 loc) · 104 KB
/
CofenseVision.yml
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
category: Data Enrichment & Threat Intelligence
commonfields:
id: Cofense Vision
version: -1
configuration:
- name: url
display: Server URL
required: true
defaultvalue:
type: 0
additionalinfo: Server URL to connect to Cofense Vision.
- name: credentials
display: Client ID
required: true
defaultvalue:
type: 9
additionalinfo:
displaypassword: Client Secret
- name: threat_levels_good
display: Threat levels to be marked as Good
defaultvalue:
type: 0
additionalinfo: |-
Mapping of Cofense Vision threat level to XSOAR DbotScore.
For 'Good', DbotScore will be 1 and default threat level value is 'low'.
Comma separated values are supported.
- name: threat_levels_suspicious
display: Threat levels to be marked as Suspicious
defaultvalue:
type: 0
additionalinfo: |-
Mapping of Cofense Vision threat level to XSOAR DbotScore.
For 'Suspicious', DbotScore will be 2 and default threat level values are 'suspicious', 'moderate', 'substantial'.
Comma separated values are supported.
- name: threat_levels_bad
display: Threat levels to be marked as Bad
defaultvalue:
type: 0
additionalinfo: |-
Mapping of Cofense Vision threat level to XSOAR DbotScore.
For 'Bad', DbotScore will be 3 and default threat level values are 'malicious', 'severe', 'critical', 'high'.
Comma separated values are supported.
- name: insecure
display: Trust any certificate (not secure)
defaultvalue: 'false'
type: 8
additionalinfo: Indicates whether to allow connections without verifying SSL certificate's validity.
- name: proxy
display: Use system proxy settings
defaultvalue: 'false'
type: 8
additionalinfo: Indicates whether to use XSOAR's system proxy settings to connect to the API.
description: The Cofense Vision integration provides commands to initiate advanced search jobs to hunt suspicious emails matching IOCs. It also contains commands to quarantine emails, download messages and their attachments, and aids to manage IOCs in the local repository to keep up with upcoming emerging threats.
display: Cofense Vision
name: Cofense Vision
script:
commands:
- arguments:
- description: |-
A one-time token to access the content of an email in a zip file.
Note: Users can get the token by executing the "cofense-message-token-get" command.
name: token
required: true
description: Fetches full content of an email and returns it as a zip file using a token.
name: cofense-message-get
outputs:
- contextPath: File.Size
description: The size of the file.
type: Number
- contextPath: File.SHA1
description: The SHA1 hash of the file.
type: String
- contextPath: File.SHA256
description: The SHA256 hash of the file.
type: String
- contextPath: File.Name
description: The name of the file.
type: String
- contextPath: File.SSDeep
description: The SSDeep hash of the file.
type: String
- contextPath: File.EntryID
description: The entry ID of the file.
type: String
- contextPath: File.Info
description: File information.
type: String
- contextPath: File.Type
description: The file type.
type: String
- contextPath: File.MD5
description: The MD5 hash of the file.
type: String
- contextPath: File.Extension
description: The file extension.
type: String
- arguments:
- description: |-
Unique identifier of the email, enclosed in angle brackets.
Example: <AC6CAE11-779E-4044-BB25-110171AB0301@example.com>
Note: Users can get the internet message ID by executing the "cofense-message-search-results-get" command.
name: internet_message_id
required: true
- description: |-
Email address of the recipient of an email. The email address can be a
carbon copy (Cc) or blind carbon copy (Bcc) recipient but cannot be a
shared mailbox or a distribution list.
Note: Users can get the recipient address by executing the "cofense-message-search-results-get" command.
name: recipient_address
required: true
description: Retrieves the full content of a message that matches the specified Internet message ID and recipient email address of an email.
name: cofense-message-metadata-get
outputs:
- contextPath: Cofense.Message.id
description: ID of the message in cofense vision.
type: Number
- contextPath: Cofense.Message.storageUri
description: Storage URI of an email.
type: String
- contextPath: Cofense.Message.subject
description: Subject of the email.
type: String
- contextPath: Cofense.Message.receivedOn
description: Date and time an email was received by the recipient.
type: Date
- contextPath: Cofense.Message.sentOn
description: Date and time an email was sent to the recipient.
type: Date
- contextPath: Cofense.Message.deliveredOn
description: Date and time an email was delivered to the recipient.
type: Date
- contextPath: Cofense.Message.processedOn
description: Date and time cofense vision ingested the email.
type: Date
- contextPath: Cofense.Message.textBody
description: Body of an email in text format.
type: String
- contextPath: Cofense.Message.htmlBody
description: Body of an email in HTML format.
type: String
- contextPath: Cofense.Message.md5
description: MD5 hash of the message.
type: String
- contextPath: Cofense.Message.sha1
description: SHA1 hash of the message.
type: String
- contextPath: Cofense.Message.sha256
description: SHA256 hash of the message.
type: String
- contextPath: Cofense.Message.internetMessageId
description: ID of an email assigned by the message transfer agent.
type: String
- contextPath: Cofense.Message.from.id
description: ID of the sender.
type: Number
- contextPath: Cofense.Message.from.personal
description: Personal email of the sender.
type: String
- contextPath: Cofense.Message.from.address
description: An email address of the sender.
type: String
- contextPath: Cofense.Message.headers.name
description: The name of the key in the header.
type: String
- contextPath: Cofense.Message.headers.value
description: The value of the key in the header.
type: String
- contextPath: Cofense.Message.recipients.id
description: ID of the recipient.
type: Number
- contextPath: Cofense.Message.recipients.personal
description: Personal email of the recipient.
type: String
- contextPath: Cofense.Message.recipients.address
description: Email address of the recipient.
type: String
- contextPath: Cofense.Message.recipients.recipientType
description: Type of the recipient.
type: String
- contextPath: Cofense.Message.attachments.size
description: The size of the attachment file.
type: Number
- contextPath: Cofense.Message.attachments.filename
description: The name of the attachment file.
type: String
- contextPath: Cofense.Message.attachments.contentType
description: The content type present in the header.
type: String
- contextPath: Cofense.Message.attachments.detectedContentType
description: The detected content type of the attachment.
type: String
- contextPath: Cofense.Message.attachments.md5
description: The MD5 hash of the attachment.
type: String
- contextPath: Cofense.Message.attachments.sha256
description: The SHA256 hash of the attachment.
type: String
- contextPath: Cofense.Message.attachments.id
description: The ID of the attachment.
type: Number
- contextPath: Cofense.Message.matchingIOCs
description: MD5 hash of one or more matching IOCs.
type: Unknown
- contextPath: Cofense.Message.matchingSources
description: One or more matching IOC sources.
type: Unknown
- arguments:
- description: |-
The hex-encoded string that represents an attachment's MD5 hash.
Note: The md5 hash can be retrieved by using the command "cofense-message-search-results-get".
name: md5
required: true
- description: |-
The hex-encoded string that represents an attachment's SHA256 hash.
Note: The sha256 hash can be retrieved by using the command "cofense-message-search-results-get".
name: sha256
- description: |-
Provide a name to the file with the extension that needs to be downloaded.
Note: The file name can be retrieved by using the command "cofense-message-search-results-get".
name: file_name
required: true
description: Fetches the full content of an email and returns a zip file.
name: cofense-message-attachment-get
outputs:
- contextPath: File.Size
description: The size of the file in bytes.
type: Number
- contextPath: File.SHA1
description: The SHA1 hash of the file.
type: String
- contextPath: File.SHA256
description: The SHA256 hash of the file.
type: String
- contextPath: File.Name
description: The name of the file.
type: String
- contextPath: File.SSDeep
description: The SSDeep hash of the file.
type: String
- contextPath: File.EntryID
description: The entry ID of the file.
type: String
- contextPath: File.Info
description: File information.
type: String
- contextPath: File.Type
description: The file type.
type: String
- contextPath: File.MD5
description: The MD5 hash of the file.
type: String
- contextPath: File.Extension
description: The file extension.
type: String
- arguments:
- description: |-
Unique identifier of the email, enclosed in angle brackets.
Example: <AC6CAE11-779E-4044-BB25-110171AB0301@example.com>
Note: Users can get the ID by executing the "cofense-message-search-results-get" command.
name: internet_message_id
required: true
- description: |-
Email address of the recipient of the email.
Note: The email address can be a carbon copy (Cc) or blind
carbon copy (Bcc) recipient but cannot be a shared mailbox or a
distribution list.
Note: Users can get the recipient address by executing the "cofense-message-search-results-get" command.
name: recipient_address
required: true
- description: Password to protect the zip file containing the email.
name: password
description: Retrieves a one-time token that can be used to get an email's content.
name: cofense-message-token-get
outputs:
- contextPath: Cofense.Message.token
description: One-time token to access an email content.
type: String
- contextPath: Cofense.Message.internetMessageId
description: ID of an email assigned by the message transfer agent.
type: String
- contextPath: Cofense.Message.recipients.address
description: Email address of the recipient.
type: String
- arguments:
- auto: PREDEFINED
defaultValue: 'False'
description: Whether to remove (true) or not remove (false) quarantined emails from the response.
name: exclude_quarantine_emails
predefined:
- 'True'
- 'False'
- defaultValue: '0'
description: Start page of the results. The value must be a positive integer or 0.
name: page
- defaultValue: '50'
description: The number of results to retrieve per page. The value must be a positive integer up to 2000.
name: size
- defaultValue: id:asc
description: |-
The name-value pair defining the order of the response. Comma separated values are supported.
Supported format: propertyName1:sortOrder1,propertyName2:sortOrder2
Supported values for propertyName are: id, createdBy, createdDate, modifiedBy, modifiedDate, stopRequested.
Supported values for sortOrder are: asc, desc.
isArray: true
name: sort
- auto: PREDEFINED
description: Whether to include auto quarantine jobs (true) or not include auto quarantine jobs (false).
name: auto_quarantine
predefined:
- 'True'
- 'False'
- description: |-
Filters quarantine jobs by including emails with the specified status. Supports comma-separated values.
Supported values are: NEW, PENDING_APPROVAL, QUEUED, RUNNING, COMPLETED, FAILED.
Where,
NEW: Job was created but is not yet queued.
PENDING_APPROVAL: Job was created from an auto quarantine action and is waiting for approval to run.
QUEUED: Job is queued but has not yet run.
RUNNING: Job is currently running.
COMPLETED: Job run finished and emails were quarantined or restored.
FAILED: Job run finished but some emails to be quarantined or restored are in an error state. Cofense Vision retries failed jobs until the retry limit is reached.
isArray: true
name: include_status
- description: |-
Filters quarantine jobs by excluding emails with the specified status. Supports comma-separated values.
Supported values are: NEW, PENDING_APPROVAL, QUEUED, RUNNING, COMPLETED, FAILED.
Where,
NEW: Job was created but is not yet queued.
PENDING_APPROVAL: Job was created from an auto quarantine action and is waiting for approval to run.
QUEUED: Job is queued but has not yet run.
RUNNING: Job is currently running.
COMPLETED: Job run finished and emails were quarantined or restored.
FAILED: Job run finished but some emails to be quarantined or restored are in an error state. Cofense Vision retries failed jobs until the retry limit is reached.
isArray: true
name: exclude_status
- description: |-
Unique MD5 hash identifier of one or more IOCs. Comma separated values are supported.
Example:
07fa1e91f99050521a87edc784e83fd5,07123459050525189160784e83fd5
isArray: true
name: iocs
- description: |-
Emails modified after this date and time. The date and time must be in UTC.
Supported formats: N minutes, N hours, N days, N weeks, N months, N years, yyyy-mm-dd, yyyy-mm-ddTHH:MM:SSZ
For example: 01 Mar 2021, 01 Feb 2021 04:45:33, 2022-04-17T14:05:44Z
name: modified_date_after
- description: |-
One or more configured IOC sources. Comma separated values are supported.
Example: Intelligence, Triage-1
isArray: true
name: sources
description: Filters and returns a paginated list of matching quarantine jobs.
name: cofense-quarantine-jobs-list
outputs:
- contextPath: Cofense.QuarantineJob.id
description: ID of the quarantine job in cofense vision.
type: Number
- contextPath: Cofense.QuarantineJob.createdBy
description: Client that created the quarantine job.
type: String
- contextPath: Cofense.QuarantineJob.createdDate
description: Date and time the quarantine job was created. The timestamp is in UTC.
type: Date
- contextPath: Cofense.QuarantineJob.modifiedBy
description: Client that last updated the quarantine job.
type: String
- contextPath: Cofense.QuarantineJob.modifiedDate
description: Date and time the quarantine job was last modified. The timestamp is in UTC.
type: Date
- contextPath: Cofense.QuarantineJob.stopRequested
description: Whether a request was issued (true) or was not issued (false) to stop the quarantine job.
type: Boolean
- contextPath: Cofense.QuarantineJob.emailCount
description: Number of emails quarantined.
type: Number
- contextPath: Cofense.QuarantineJob.quarantineEmails.createdDate
description: Date the quarantine job was created.
type: Date
- contextPath: Cofense.QuarantineJob.quarantineEmails.errorMessage
description: Error message.
type: String
- contextPath: Cofense.QuarantineJob.quarantineEmails.ewsMessageId
description: ID of the email in EWS.
type: String
- contextPath: Cofense.QuarantineJob.quarantineEmails.id
description: ID in cofense vision.
type: Number
- contextPath: Cofense.QuarantineJob.quarantineEmails.internetMessageID
description: ID of the email assigned by the message transfer agent.
type: String
- contextPath: Cofense.QuarantineJob.quarantineEmails.originalFolderId
description: ID of the EWS folder where the email was located before it was quarantined.
type: String
- contextPath: Cofense.QuarantineJob.quarantineEmails.quarantinedDate
description: The date when an email was quarantined.
type: Date
- contextPath: Cofense.QuarantineJob.quarantineEmails.recipientAddress
description: Email address of the account containing the emails to be quarantined.
type: String
- contextPath: Cofense.QuarantineJob.quarantineEmails.status
description: Status of the email.
type: String
- contextPath: Cofense.QuarantineJob.quarantineJobRuns.completedDate
description: Date the quarantine job completed.
type: Date
- contextPath: Cofense.QuarantineJob.quarantineJobRuns.error
description: Total number of errors in the quarantine job.
type: Number
- contextPath: Cofense.QuarantineJob.quarantineJobRuns.id
description: ID of the quarantine job in Cofense Vision.
type: Number
- contextPath: Cofense.QuarantineJob.quarantineJobRuns.jobRunType
description: Type of Job depending on the operation being performed against the emails.
type: String
- contextPath: Cofense.QuarantineJob.quarantineJobRuns.startedDate
description: Date the quarantine job started.
type: Date
- contextPath: Cofense.QuarantineJob.quarantineJobRuns.status
description: Status of the quarantine job.
type: String
- contextPath: Cofense.QuarantineJob.quarantineJobRuns.total
description: Total number of emails in the quarantine job.
type: Number
- contextPath: Cofense.QuarantineJob.autoQuarantine
description: Whether the quarantine job was part of an auto quarantine action (true) or was not part of an auto quarantine action (false).
type: Boolean
- contextPath: Cofense.QuarantineJob.matchingIOCs
description: MD5 hash of one or more matching IOCs.
type: Unknown
- contextPath: Cofense.QuarantineJob.matchingSources
description: One or more IOC sources.
type: Unknown
- contextPath: Cofense.QuarantineJob.matchingIocInfo.id
description: MD5 hash composed of the UTF-8 concatenation of "threat_type" and "threat_value" attributes.
type: String
- contextPath: Cofense.QuarantineJob.matchingIocInfo.type
description: Type of the cofense resource which is always "ioc".
type: String
- contextPath: Cofense.QuarantineJob.matchingIocInfo.attributes.threat_type
description: Threat type of the IOC match.
type: String
- contextPath: Cofense.QuarantineJob.matchingIocInfo.attributes.threat_value
description: Actual value of the IOC match in the email.
type: String
- contextPath: Cofense.QuarantineJob.matchingIocInfo.metadata.source
description: Data that the IOC source reads and writes.
type: Unknown
- contextPath: Cofense.QuarantineJob.matchingIocInfo.metadata.quarantine.source_names
description: Array containing the IOC sources.
type: Unknown
- contextPath: Cofense.QuarantineJob.matchingIocInfo.metadata.quarantine.expires_at
description: Date and time in UTC, after which this IOC expires.
type: Date
- contextPath: Cofense.QuarantineJob.matchingIocInfo.metadata.quarantine.created_at
description: Date and time the quarantine data was created in the IOC repository. The timestamp is in UTC.
type: Date
- contextPath: Cofense.QuarantineJob.matchingIocInfo.metadata.quarantine.first_quarantined_at
description: Date and time Cofense Vision quarantined the first email due to this IOC. The timestamp is in UTC.
type: Date
- contextPath: Cofense.QuarantineJob.matchingIocInfo.metadata.quarantine.last_quarantined_at
description: Date and time Cofense Vision quarantined the last email due to this IOC. The timestamp is in UTC.
type: Date
- contextPath: Cofense.QuarantineJob.matchingIocInfo.metadata.quarantine.match_count
description: Number of unique emails that matched the IOC while the IOC was active.
type: Number
- contextPath: Cofense.QuarantineJob.matchingIocInfo.metadata.quarantine.quarantine_count
description: Number of recipients who received emails matching the IOC while the IOC was active.
type: Number
- contextPath: Cofense.QuarantineJob.matchingIocInfo.metadata.quarantine.expired
description: Whether the IOC is expired (true) or not expired (false).
type: Boolean
- contextPath: Cofense.QuarantineJob.searchId
description: ID that Cofense Vision assigned to the search, if any.
type: Number
- arguments:
- description: |-
A comma-separated string of quarantine emails, specifying the internet
message ID and the recipient address of the email.
Supported format:
internetMessageID1:recipientAddress1, internetMessageID2:recipientAddress2
Where,
internetMessageID: IDs of any emails in the particular account to be
quarantined, with each internet message ID enclosed in angle brackets.
recipientAddress: Email address of the account containing the emails to be quarantined.
Example: <513C8CD8-E593-4DC4-82BF6202E8AC95CB>:mail054@example.com,
<41348CD8-E593-4DC4-82BF6202E8AC95CB>:ma32il054@example.com
Note: Users can get the internet message ID and recipient address by
executing the "cofense-message-search-results-get" command.
isArray: true
name: quarantine_emails
required: true
description: Creates a new quarantine job.
name: cofense-quarantine-job-create
outputs:
- contextPath: Cofense.QuarantineJob.id
description: ID of the quarantine job in cofense vision.
type: Number
- contextPath: Cofense.QuarantineJob.createdBy
description: Client that created the quarantine job.
type: String
- contextPath: Cofense.QuarantineJob.createdDate
description: Date and time the quarantine job was created. The timestamp is in UTC.
type: Date
- contextPath: Cofense.QuarantineJob.modifiedBy
description: Client that last updated the quarantine job.
type: String
- contextPath: Cofense.QuarantineJob.modifiedDate
description: Date and time the quarantine job was last modified. The timestamp is in UTC.
type: Date
- contextPath: Cofense.QuarantineJob.stopRequested
description: Whether a request was issued (true) or was not issued (false) to stop the quarantine job.
type: Boolean
- contextPath: Cofense.QuarantineJob.emailCount
description: Number of emails quarantined.
type: Number
- contextPath: Cofense.QuarantineJob.quarantineEmails.createdDate
description: Date the quarantine job was created.
type: Date
- contextPath: Cofense.QuarantineJob.quarantineEmails.errorMessage
description: Error message.
type: String
- contextPath: Cofense.QuarantineJob.quarantineEmails.ewsMessageId
description: ID of the email in EWS.
type: String
- contextPath: Cofense.QuarantineJob.quarantineEmails.id
description: ID in cofense vision.
type: Number
- contextPath: Cofense.QuarantineJob.quarantineEmails.internetMessageID
description: ID of the email assigned by the message transfer agent.
type: String
- contextPath: Cofense.QuarantineJob.quarantineEmails.originalFolderId
description: ID of the EWS folder where the email was located before it was quarantined.
type: String
- contextPath: Cofense.QuarantineJob.quarantineEmails.quarantinedDate
description: Date the email was quarantined.
type: Date
- contextPath: Cofense.QuarantineJob.quarantineEmails.recipientAddress
description: Email address of the account containing the emails to be quarantined.
type: String
- contextPath: Cofense.QuarantineJob.quarantineEmails.status
description: Status of the email.
type: String
- contextPath: Cofense.QuarantineJob.quarantineJobRuns.completedDate
description: Date the quarantine job completed.
type: Date
- contextPath: Cofense.QuarantineJob.quarantineJobRuns.error
description: Total number of errors in the quarantine job.
type: Number
- contextPath: Cofense.QuarantineJob.quarantineJobRuns.id
description: ID of the quarantine job in Cofense Vision.
type: Number
- contextPath: Cofense.QuarantineJob.quarantineJobRuns.jobRunType
description: Type of Job depending on the operation being performed against the emails.
type: String
- contextPath: Cofense.QuarantineJob.quarantineJobRuns.startedDate
description: Date the quarantine job started.
type: Date
- contextPath: Cofense.QuarantineJob.quarantineJobRuns.status
description: Status of the quarantine job.
type: String
- contextPath: Cofense.QuarantineJob.quarantineJobRuns.total
description: Total number of emails in the quarantine job.
type: Number
- contextPath: Cofense.QuarantineJob.autoQuarantine
description: Whether the quarantine job was part of an auto quarantine action (true) or was not part of an auto quarantine action (false).
type: Boolean
- contextPath: Cofense.QuarantineJob.matchingIOCs
description: MD5 hash of one or more matching IOCs.
type: Unknown
- contextPath: Cofense.QuarantineJob.matchingSources
description: One or more IOC sources.
type: Unknown
- contextPath: Cofense.QuarantineJob.matchingIocInfo.id
description: MD5 hash composed of the UTF-8 concatenation of "threat_type" and "threat_value" attributes.
type: String
- contextPath: Cofense.QuarantineJob.matchingIocInfo.type
description: Type of the cofense resource which is always "ioc".
type: String
- contextPath: Cofense.QuarantineJob.matchingIocInfo.attributes.threat_type
description: Threat type of the IOC match.
type: String
- contextPath: Cofense.QuarantineJob.matchingIocInfo.attributes.threat_value
description: Actual value of the IOC match in the email.
type: String
- contextPath: Cofense.QuarantineJob.matchingIocInfo.metadata.source
description: Data that the IOC source reads and writes.
type: Unknown
- contextPath: Cofense.QuarantineJob.matchingIocInfo.metadata.quarantine.source_names
description: Array containing the IOC sources.
type: Unknown
- contextPath: Cofense.QuarantineJob.matchingIocInfo.metadata.quarantine.expires_at
description: Date and time, in UTC, after which this IOC expires.
type: Date
- contextPath: Cofense.QuarantineJob.matchingIocInfo.metadata.quarantine.created_at
description: Date and time the quarantine data was created in the IOC repository. The timestamp is in UTC.
type: Date
- contextPath: Cofense.QuarantineJob.matchingIocInfo.metadata.quarantine.first_quarantined_at
description: Date and time Cofense Vision quarantined the first email due to this IOC. The timestamp is in UTC.
type: Date
- contextPath: Cofense.QuarantineJob.matchingIocInfo.metadata.quarantine.last_quarantined_at
description: Date and time Cofense Vision quarantined the last email due to this IOC. The timestamp is in UTC.
type: Date
- contextPath: Cofense.QuarantineJob.matchingIocInfo.metadata.quarantine.match_count
description: Number of unique emails that matched the IOC while the IOC was active.
type: Number
- contextPath: Cofense.QuarantineJob.matchingIocInfo.metadata.quarantine.quarantine_count
description: Number of recipients who received emails matching the IOC while the IOC was active.
type: Number
- contextPath: Cofense.QuarantineJob.matchingIocInfo.metadata.quarantine.expired
description: Whether the IOC is expired (true) or not expired (false).
type: Boolean
- contextPath: Cofense.QuarantineJob.searchId
description: ID that Cofense Vision assigned to the search, if any.
type: Number
- arguments:
- defaultValue: '0'
description: |-
The start page of the results. The value must be a positive integer or 0.
name: page
- defaultValue: '50'
description: |-
The number of results to retrieve per page. The value must be a positive integer up to 2000.
name: size
- defaultValue: 'id:asc'
description: |-
The name-value pair defining the order of the response. Comma separated values are supported.
Supported format: propertyName1:sortOrder1,propertyName2:sortOrder2
Supported values for propertyName are: id, createdBy, createdDate, modifiedBy,
modifiedDate, receivedAfterDate, receivedBeforeDate.
Supported values for sortOrder are: asc, desc.
isArray: true
name: sort
description: Retrieves the list of searches.
name: cofense-message-searches-list
outputs:
- contextPath: Cofense.Search.id
description: ID that Cofense Vision assigned to the search.
type: String
- contextPath: Cofense.Search.createdBy
description: Username of the client that created the search.
type: String
- contextPath: Cofense.Search.createdDate
description: Date and time the search was created. The timestamp is in UTC.
type: Date
- contextPath: Cofense.Search.modifiedBy
description: Username of the last client that updated the search.
type: String
- contextPath: Cofense.Search.modifiedDate
description: Date and time the search was last modified. The timestamp is in UTC.
type: Date
- contextPath: Cofense.Search.subjects
description: List of email subjects.
type: Unknown
- contextPath: Cofense.Search.senders
description: List of sender's email addresses.
type: Unknown
- contextPath: Cofense.Search.recipient
description: Email address of the recipient.
type: String
- contextPath: Cofense.Search.attachmentNames
description: List of attachment file names.
type: Unknown
- contextPath: Cofense.Search.attachmentHashCriteria.type
description: The type of matching for attachment hash.
type: String
- contextPath: Cofense.Search.attachmentHashCriteria.attachmentHashes.hashType
description: The type of hash. Either MD5 or SHA256.
type: String
- contextPath: Cofense.Search.attachmentHashCriteria.attachmentHashes.hashString
description: The hash of the attachment file.
type: String
- contextPath: Cofense.Search.domainCriteria.type
description: The type of matching for domains.
type: String
- contextPath: Cofense.Search.domainCriteria.domains
description: List of domains.
type: Unknown
- contextPath: Cofense.Search.domainCriteria.domains.whiteListUrls
description: List of URLs to white list.
type: Unknown
- contextPath: Cofense.Search.attachmentMimeTypes
description: List of MIME types.
type: Unknown
- contextPath: Cofense.Search.attachmentExcludeMimeTypes
description: List of MIME types to exclude.
type: Unknown
- contextPath: Cofense.Search.receivedAfterDate
description: Filters for emails received on or after this date and time.
type: Date
- contextPath: Cofense.Search.receivedBeforeDate
description: Filters for emails received before or on this date and time.
type: Date
- contextPath: Cofense.Search.url
description: The URL to search for.
type: String
- contextPath: Cofense.Search.internetMessageId
description: Unique identifier of the email.
type: String
- contextPath: Cofense.Search.headers.key
description: The name of the key in the header.
type: String
- contextPath: Cofense.Search.headers.values
description: The value of the key in the header.
type: String
- contextPath: Cofense.Search.partialIngest
description: Indicates whether to search partially ingested emails or not.
type: Boolean
- arguments:
- description: |-
The unique ID that cofense vision has assigned to a search.
Note: The ID can be retrieved by using the command "cofense-message-searches-list".
name: id
required: true
description: Retrieves the result of the search identified by an ID.
name: cofense-message-search-get
outputs:
- contextPath: Cofense.Search.id
description: ID that Cofense Vision assigned to the search.
type: String
- contextPath: Cofense.Search.createdBy
description: Username of the client that created the search.
type: String
- contextPath: Cofense.Search.createdDate
description: Date and time the search was created. The timestamp is in UTC.
type: Date
- contextPath: Cofense.Search.modifiedBy
description: Username of the last client that updated the search.
type: String
- contextPath: Cofense.Search.modifiedDate
description: Date and time the search was last modified. The timestamp is in UTC.
type: Date
- contextPath: Cofense.Search.subjects
description: List of email subjects.
type: Unknown
- contextPath: Cofense.Search.senders
description: List of sender's email addresses.
type: Unknown
- contextPath: Cofense.Search.recipient
description: Email address of the recipient.
type: String
- contextPath: Cofense.Search.attachmentNames
description: List of attachment file names.
type: Unknown
- contextPath: Cofense.Search.attachmentHashCriteria.type
description: The type of matching for attachment hash.
type: String
- contextPath: Cofense.Search.attachmentHashCriteria.attachmentHashes.hashType
description: The type of hash. Either MD5 or SHA256.
type: String
- contextPath: Cofense.Search.attachmentHashCriteria.attachmentHashes.hashString
description: The hash of the attachment file.
type: String
- contextPath: Cofense.Search.domainCriteria.type
description: The type of matching for domains.
type: String
- contextPath: Cofense.Search.domainCriteria.domains
description: List of domains.
type: Unknown
- contextPath: Cofense.Search.domainCriteria.domains.whiteListUrls
description: List of URLs to white list.
type: Unknown
- contextPath: Cofense.Search.attachmentMimeTypes
description: List of MIME types.
type: Unknown
- contextPath: Cofense.Search.attachmentExcludeMimeTypes
description: List of MIME types to exclude.
type: Unknown
- contextPath: Cofense.Search.receivedAfterDate
description: Filters the emails received on or after this date and time.
type: Date
- contextPath: Cofense.Search.receivedBeforeDate
description: Filters the emails received before or on this date and time.
type: Date
- contextPath: Cofense.Search.url
description: The URL to be searched for.
type: String
- contextPath: Cofense.Search.internetMessageId
description: Unique identifier of the email.
type: String
- contextPath: Cofense.Search.headers.key
description: The name of the key in the header.
type: String
- contextPath: Cofense.Search.headers.values
description: The value of the key in the header.
type: String
- contextPath: Cofense.Search.partialIngest
description: Indicates whether to search partially ingested emails or not.
type: Boolean
- arguments:
- description: |-
ID of the quarantine job in cofense vision to be restored.
Note: Users can get the list of ID by executing the "cofense-quarantine-jobs-list" command.
name: id
required: true
description: Restores emails quarantined by the job identified by its unique ID.
name: cofense-quarantine-job-restore
outputs:
- contextPath: Cofense.QuarantineJob.id
description: ID of the quarantine job in cofense vision.
type: Number
- contextPath: Cofense.QuarantineJob.isRestored
description: Whether the quarantine job is successfully restored(true) or not(false).
type: Boolean
- arguments:
- description: |-
ID of the quarantine job in cofense vision to be retrieved.
Note: Users can get the list of IDs by executing the "cofense-quarantine-jobs-list" command.
name: id
required: true
description: Retrieves quarantine job identified by its unique ID.
name: cofense-quarantine-job-get
outputs:
- contextPath: Cofense.QuarantineJob.id
description: ID of the quarantine job in cofense vision.
type: Number
- contextPath: Cofense.QuarantineJob.createdBy
description: Client that created the quarantine job.
type: String
- contextPath: Cofense.QuarantineJob.createdDate
description: Date and time the quarantine job was created. The timestamp is in UTC.
type: Date
- contextPath: Cofense.QuarantineJob.modifiedBy
description: Client that last updated the quarantine job.
type: String
- contextPath: Cofense.QuarantineJob.modifiedDate
description: Date and time the quarantine job was last modified. The timestamp is in UTC.
type: Date
- contextPath: Cofense.QuarantineJob.stopRequested
description: Whether a request was issued (true) or was not issued (false) to stop the quarantine job.
type: Boolean
- contextPath: Cofense.QuarantineJob.emailCount
description: Number of emails quarantined.
type: Number
- contextPath: Cofense.QuarantineJob.quarantineEmails.createdDate
description: Date the quarantine job was created.
type: Date
- contextPath: Cofense.QuarantineJob.quarantineEmails.errorMessage
description: Error message.
type: String
- contextPath: Cofense.QuarantineJob.quarantineEmails.ewsMessageId
description: ID of the email in EWS.
type: String
- contextPath: Cofense.QuarantineJob.quarantineEmails.id
description: ID in cofense vision.
type: Number
- contextPath: Cofense.QuarantineJob.quarantineEmails.internetMessageID
description: ID of the email assigned by the message transfer agent.
type: String
- contextPath: Cofense.QuarantineJob.quarantineEmails.originalFolderId
description: ID of the EWS folder where the email was located before it was quarantined.
type: String
- contextPath: Cofense.QuarantineJob.quarantineEmails.quarantinedDate
description: Date the email was quarantined.
type: Date
- contextPath: Cofense.QuarantineJob.quarantineEmails.recipientAddress
description: Email address of the account containing the emails to be quarantined.
type: String
- contextPath: Cofense.QuarantineJob.quarantineEmails.status
description: Status of the email.
type: String
- contextPath: Cofense.QuarantineJob.quarantineJobRuns.completedDate
description: Date the quarantine job completed.
type: Date
- contextPath: Cofense.QuarantineJob.quarantineJobRuns.error
description: Total number of errors in the quarantine job.
type: Number
- contextPath: Cofense.QuarantineJob.quarantineJobRuns.id
description: ID of the quarantine job in Cofense Vision.
type: Number
- contextPath: Cofense.QuarantineJob.quarantineJobRuns.jobRunType
description: Type of Job depending on the operation being performed against the emails.
type: String
- contextPath: Cofense.QuarantineJob.quarantineJobRuns.startedDate
description: Date the quarantine job started.
type: Date
- contextPath: Cofense.QuarantineJob.quarantineJobRuns.status
description: Status of the quarantine job.
type: String
- contextPath: Cofense.QuarantineJob.quarantineJobRuns.total
description: Total number of emails in the quarantine job.
type: Number
- contextPath: Cofense.QuarantineJob.autoQuarantine
description: Whether the quarantine job was part of an auto quarantine action (true) or was not part of an auto quarantine action (false).
type: Boolean
- contextPath: Cofense.QuarantineJob.matchingIOCs
description: MD5 hash of one or more matching IOCs.
type: Unknown
- contextPath: Cofense.QuarantineJob.matchingSources
description: One or more IOC sources.
type: Unknown
- contextPath: Cofense.QuarantineJob.matchingIocInfo.id
description: MD5 hash composed of the UTF-8 concatenation of "threat_type" and "threat_value" attributes.
type: String
- contextPath: Cofense.QuarantineJob.matchingIocInfo.type
description: Type of the cofense resource which is always "ioc".
type: String
- contextPath: Cofense.QuarantineJob.matchingIocInfo.attributes.threat_type
description: Threat type of the IOC match.
type: String
- contextPath: Cofense.QuarantineJob.matchingIocInfo.attributes.threat_value
description: Actual value of the IOC match in the email.
type: String
- contextPath: Cofense.QuarantineJob.matchingIocInfo.metadata.source
description: Data that the IOC source reads and writes.
type: Unknown
- contextPath: Cofense.QuarantineJob.matchingIocInfo.metadata.quarantine.source_names
description: Array containing the IOC sources.
type: Unknown
- contextPath: Cofense.QuarantineJob.matchingIocInfo.metadata.quarantine.expires_at
description: Date and time in UTC, after which this IOC expires.
type: Date
- contextPath: Cofense.QuarantineJob.matchingIocInfo.metadata.quarantine.created_at
description: Date and time the quarantine data was created in the IOC repository. The timestamp is in UTC.
type: Date
- contextPath: Cofense.QuarantineJob.matchingIocInfo.metadata.quarantine.first_quarantined_at
description: Date and time Cofense Vision quarantined the first email due to this IOC. The timestamp is in UTC.
type: Date
- contextPath: Cofense.QuarantineJob.matchingIocInfo.metadata.quarantine.last_quarantined_at
description: Date and time Cofense Vision quarantined the last email due to this IOC. The timestamp is in UTC.
type: Date
- contextPath: Cofense.QuarantineJob.matchingIocInfo.metadata.quarantine.match_count
description: Number of unique emails that matched the IOC while the IOC was active.
type: Number
- contextPath: Cofense.QuarantineJob.matchingIocInfo.metadata.quarantine.quarantine_count
description: Number of recipients who received emails matching the IOC while the IOC was active.
type: Number
- contextPath: Cofense.QuarantineJob.matchingIocInfo.metadata.quarantine.expired
description: Whether the IOC is expired (true) or not expired (false).
type: Boolean
- contextPath: Cofense.QuarantineJob.searchId
description: ID that Cofense Vision assigned to the search, if any.
type: Number
- arguments:
- description: |-
ID of the quarantine job in cofense vision to be approved.
Note: Users can get the list of IDs by executing the "cofense-quarantine-jobs-list" command.
name: id
required: true
- description: Number of emails containing IOC matches to be quarantined. When message_count is present, cofense vision quarantines a subset of the total number of emails containing IOC matches. The value must be a non-zero and positive integer. If message_count is not present, all messages will be approved.
name: message_count
description: Approves the quarantine job identified by its unique ID. When the "Auto Quarantine" feature is configured which requires manual approvals, this command can approve all the pending quarantine jobs.
name: cofense-quarantine-job-approve
outputs:
- contextPath: Cofense.QuarantineJob.id
description: ID of the quarantine job in cofense vision.
type: Number
- contextPath: Cofense.QuarantineJob.isApproved
description: Whether the quarantine job is successfully approved(true) or not(false).
type: Boolean
- arguments:
- description: |-
ID of the quarantine job in cofense vision to be deleted.
Note: Users can get the list of IDs by executing the "cofense-quarantine-jobs-list" command.
name: id
required: true
description: Deletes the quarantine job identified by its unique ID.
execution: true
name: cofense-quarantine-job-delete
outputs:
- contextPath: Cofense.QuarantineJob.id
description: ID of the quarantine job in cofense vision.
type: Number
- contextPath: Cofense.QuarantineJob.isDeleted
description: Whether the quarantine job is successfully deleted(true) or not(false).
type: Boolean
- arguments: