/
KnowBe4KMSAT.py
1343 lines (1100 loc) · 37.7 KB
/
KnowBe4KMSAT.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
"""Base Integration for Cortex XSOAR (aka Demisto)
This is an empty Integration with some basic structure according
to the code conventions.
MAKE SURE YOU REVIEW/REPLACE ALL THE COMMENTS MARKED AS "TODO"
Developer Documentation: https://xsoar.pan.dev/docs/welcome
Code Conventions: https://xsoar.pan.dev/docs/integrations/code-conventions
Linting: https://xsoar.pan.dev/docs/integrations/linting
This is an empty structure file. Check an example at;
https://github.com/demisto/content/blob/master/Packs/HelloWorld/Integrations/HelloWorld/HelloWorld.py
"""
from CommonServerPython import * # noqa # pylint: disable=unused-wildcard-import
from CommonServerUserPython import * # noqa
import traceback
import urllib3
from typing import Dict
# Disable insecure warnings
urllib3.disable_warnings()
""" CONSTANTS """
DATE_FORMAT = "%Y-%m-%dT%H:%M:%SZ" # ISO8601 format with UTC, default in XSOAR
""" CLIENT CLASS """
class Client(BaseClient):
"""KMSAT Client class to interact with the service API
This Client implements API calls, and does not contain any XSOAR logic.
Should only do requests and return data.
It inherits from BaseClient defined in CommonServer Python.
Most calls use _http_request() that handles proxy, SSL verification, etc.
For this implementation, no special attributes defined
"""
def __init__(self, base_url, verify, proxy, headers=None):
headers["X-KB4-Integration"] = "Cortex XSOAR KMSAT"
super().__init__(base_url=base_url, verify=verify, headers=headers, proxy=proxy)
def kmsat_account_info(self):
""" Returns account info
Returns:
dict: HTTP Response
"""
return self._http_request(
method="GET", url_suffix="/account", resp_type="json", ok_codes=(200,)
)
def kmsat_account_risk_score_history(self, params: dict):
""" Returns account risk score history
Args:
params (dict): Params for account risk score history
Returns:
dict: HTTP Response
"""
return self._http_request(
method="GET",
url_suffix="/account/risk_score_history",
resp_type="json",
ok_codes=(200,),
params=params,
)
def kmsat_groups_list(self, params: dict):
""" Returns groups
Args:
params (dict): Params for groups risk score history
Returns:
dict: HTTP Response
"""
return self._http_request(
method="GET",
url_suffix="/groups",
resp_type="json",
ok_codes=(200,),
params=params,
)
def kmsat_groups_risk_score_history(self, group_id: int, params: dict):
""" Returns groups risk score history
Args:
group_id (int): Group ID
params (dict): Params for groups risk score history
Returns:
dict: HTTP Response
"""
return self._http_request(
method="GET",
url_suffix=f"/groups/{group_id}/risk_score_history",
resp_type="json",
ok_codes=(200, ),
params=params,
)
def kmsat_groups_members(self, group_id: int, params: dict):
""" Returns groups members
Args:
group_id (int): Group ID
params (dict): Params for groups members
Returns:
dict: HTTP Response
"""
return self._http_request(
method="GET",
url_suffix=f"/groups/{group_id}/members",
resp_type="json",
ok_codes=(200, ),
params=params,
)
def kmsat_users_risk_score_history(self, user_id: int, params: dict):
""" Returns user risk score history
Args:
user_id (int): User ID
params (dict): Params for user risk score history
Returns:
dict: HTTP Response
"""
return self._http_request(
method="GET",
url_suffix=f"/users/{user_id}/risk_score_history",
resp_type="json",
ok_codes=(200, ),
params=params,
)
def kmsat_phishing_security_tests(self, params: dict):
""" Returns phishing security tests
Args:
params (dict): Params for phishing security tests
Returns:
dict: HTTP Response
"""
return self._http_request(
method="GET",
url_suffix="/phishing/security_tests",
resp_type="json",
ok_codes=(200,),
params=params,
)
def kmsat_phishing_security_tests_recipients(self, pst_id, params):
""" Returns recipients phishing security tests
Args:
pst_id (int): PST ID
params (dict): Params for recipients phishing security tests
Returns:
dict: HTTP Response
"""
return self._http_request(
method="GET",
url_suffix=f"/phishing/security_tests/{pst_id}/recipients",
resp_type="json",
ok_codes=(200, ),
params=params,
)
def kmsat_phishing_campaign_security_tests(self, campaign_id: int, params: dict):
""" Returns campaign phishing security tets
Args:
campaign_id (int): Campaign ID
params (dict): Params for campaign phishing security tests
Returns:
dict: HTTP Response
"""
return self._http_request(
method="GET",
url_suffix=f"/phishing/campaigns/{campaign_id}/security_tests",
resp_type="json",
ok_codes=(200, ),
params=params,
)
def kmsat_training_campaigns(self, params: dict):
""" Returns training campaigns
Args:
params (dict): Params for training campaigns
Returns:
dict: HTTP Response
"""
return self._http_request(
method="GET",
url_suffix="/training/campaigns",
resp_type="json",
ok_codes=(200,),
params=params,
)
def kmsat_training_enrollments(self, params):
""" Returns training enrollments
Args:
params (dict): Params for training enrollment
Returns:
dict: HTTP Response
"""
return self._http_request(
method="GET",
url_suffix="/training/enrollments",
resp_type="json",
ok_codes=(200,),
params=params,
)
class UserEventClient(BaseClient):
"""Client class to interact with the KMSAT User EventAPI"""
def __init__(self, base_url, verify, proxy, headers=None):
headers["X-KB4-Integration"] = "Cortex XSOAR KMSAT"
super().__init__(base_url=base_url, verify=verify, headers=headers, proxy=proxy)
def user_events(self, args: dict):
""" Returns user events
Args:
args (dict): Params for API call
Returns:
dict: HTTP Response
"""
params = remove_empty_elements(
{
"event_type": args.get("event_type"),
"target_user": args.get("target_user"),
"external_id": args.get("external_id"),
"source": args.get("source"),
"occurred_date": args.get("occurred_date"),
"risk_level": args.get("risk_level"),
"risk_decay_mode": args.get("risk_decay_mode"),
"risk_expire_date": args.get("risk_expire_date"),
"order_by": args.get("order_by"),
"order_direction": args.get("order_direction"),
"page": args.get("page"),
"per_page": args.get("per_page"),
}
)
return self._http_request(
method="GET",
url_suffix="/events",
resp_type="json",
ok_codes=(200,),
params=params,
)
def user_event_types(self, args: dict):
""" Returns user event types
Args:
args (dict): Params for API call
Returns:
dict: HTTP Response
"""
params = remove_empty_elements({"name": args.get("name")})
return self._http_request(
method="GET",
url_suffix="/event_types",
resp_type="json",
ok_codes=(200,),
params=params,
)
def create_user_event(self, args: dict):
""" Creates a user event
Args:
args (dict): Params for API call
Returns:
dict: HTTP Response
"""
params = remove_empty_elements(
{
"target_user": args.get("target_user"),
"event_type": args.get("event_type"),
"external_id": args.get("external_id"),
"source": args.get("source"),
"description": args.get("description"),
"occurred_date": args.get("occurred_date"),
"risk_decay_mode": args.get("risk_decay_mode"),
"risk_expire_date": args.get("risk_expire_date"),
}
)
# Converts string to int if value is set
if args.get("risk_level") is not None:
risk_level: int = int(args["risk_level"])
params["risk_level"] = risk_level
return self._http_request(
method="POST",
url_suffix="/events",
resp_type="json",
ok_codes=(201,),
json_data=params,
)
def delete_user_event(self, event_id: str):
""" Deletes a user event
Args:
args (dict): Params for API call
Returns:
dict: HTTP Response
"""
return self._http_request(
method="DELETE",
url_suffix=f"/events/{event_id}",
resp_type="response",
raise_on_status=True,
ok_codes=(204,),
)
def user_event(self, event_id: str):
""" Deletes a user event
Args:
args (dict): Params for API call
Returns:
dict: HTTP Response
"""
return self._http_request(
method="GET",
url_suffix=f"/events/{event_id}",
resp_type="json",
raise_on_status=True,
ok_codes=(200, ),
)
def user_event_status(self, request_id: str):
""" gets a specific user event create request status
Args:
args (dict): Params for API call
Returns:
dict: HTTP Response
"""
return self._http_request(
method="GET",
url_suffix=f"/statuses/{request_id}",
resp_type="json",
raise_on_status=True,
ok_codes=(200, ),
)
def user_event_statuses(self, params: dict):
""" gets a list of user event request statuses
Args:
args (dict): Params for API call
Returns:
dict: HTTP Response
"""
return self._http_request(
method="GET",
url_suffix="/statuses",
resp_type="json",
raise_on_status=True,
ok_codes=(200,),
params=params,
)
""" HELPER FUNCTIONS """
def get_pagination(args: dict):
""" Returns pagination params
Args:
args (dict): Params for pagination
Returns:
list: Returns cleaned params for paging
"""
return remove_empty_elements(
{"page": args.get("page"), "per_page": args.get("per_page")}
)
""" COMMAND FUNCTIONS """
def kmsat_account_info_list_command(client: Client, args: dict) -> CommandResults:
""" Returns account information
Args:
client (Client): Report Client
Raises:
DemistoException: Raises Demisto Exception
Returns:
CommandResults: Returns context data for account information
"""
response = client.kmsat_account_info()
markdown = tableToMarkdown(
"Account Info",
response,
[
"name",
"type",
"domains",
"admins",
"subscription_level",
"subscription_end_date",
"number_of_seats",
"current_risk_score",
],
)
return CommandResults(
outputs_prefix="KMSAT.AccountInfo",
outputs_key_field="name",
raw_response=response,
outputs=response,
readable_output=markdown,
)
def kmsat_account_risk_score_history_list_command(
client: Client, args: dict
) -> CommandResults:
""" Lists account risk score history
Args:
client (Client): Report Client
args (dict): Params for account risk score history
Raises:
DemistoException: Raises Demisto Exception
Returns:
CommandResults: Returns context data for account risk score history
"""
params = get_pagination(args)
response = client.kmsat_account_risk_score_history(params)
markdown = tableToMarkdown(
"Account Risk Score History", response, ["risk_score", "date"]
)
return CommandResults(
outputs_prefix="KMSAT.AccountRiskScoreHistory",
outputs_key_field="",
raw_response=response,
outputs=response,
readable_output=markdown,
)
def kmsat_groups_list_command(client: Client, args: dict) -> CommandResults:
params = get_pagination(args)
response = client.kmsat_groups_list(params)
markdown = tableToMarkdown(
"Groups ",
response,
[
"id",
"name",
"group_type",
"provisioning_guid",
"member_count",
"current_risk_score",
"status"
]
)
return CommandResults(
outputs_prefix="KMSAT.Groups",
outputs_key_field="id",
raw_response=response,
outputs=response,
readable_output=markdown,
)
def kmsat_groups_risk_score_history_list_command(
client: Client, args: dict
) -> CommandResults:
""" Lists groups risk score history
Args:
client (Client): Report Client
args (dict): Params for group risk score history
Raises:
DemistoException: Raises Demisto Exception
Returns:
CommandResults: Returns context data for training enrollments
"""
group_id = remove_empty_elements(args.get("group_id"))
params = get_pagination(args)
response = client.kmsat_groups_risk_score_history(group_id, params)
markdown = tableToMarkdown(
"Groups Risk Score History", response, headers=["risk_score", "date"]
)
return CommandResults(
outputs_prefix="KMSAT.GroupsRiskScoreHistory",
outputs_key_field="id",
raw_response=response,
outputs=response,
readable_output=markdown,
)
def kmsat_groups_members_list_command(
client: Client, args: dict
) -> CommandResults:
""" Lists groups members
Args:
client (Client): Report Client
args (dict): Params for groups members
Raises:
DemistoException: Raises Demisto Exception
Returns:
CommandResults: Returns context data for groups members
"""
group_id = remove_empty_elements(args.get("group_id"))
params = get_pagination(args)
response = client.kmsat_groups_members(group_id, params)
markdown = tableToMarkdown(
"Groups Members",
response,
[
"id",
"employee_number",
"first_name",
"last_name",
"job_title",
"email",
"phish_prone_percentage",
"phone_number",
"extension",
"mobile_phone_number",
"location",
"division",
"manager_name",
"manager_email",
"provisioning_managed",
"provisioning_guid",
"groups",
"current_risk_score",
"aliases",
"joined_on",
"last_sign_in",
"status",
"organization",
"department",
"language",
"comment",
"employee_start_date",
"archived_at",
"custom_field_1",
"custom_field_2",
"custom_field_3",
"custom_field_4",
"custom_date_1",
"custom_date_2",
]
)
return CommandResults(
outputs_prefix="KMSAT.GroupsMembers",
outputs_key_field="id",
raw_response=response,
outputs=response,
readable_output=markdown,
)
def kmsat_users_risk_score_history_list_command(
client: Client, args: dict
) -> CommandResults:
""" Lists user risk score history
Args:
client (Client): Report Client
args (dict): Params for user risk score history
Raises:
DemistoException: Raises Demisto Exception
Returns:
CommandResults: Returns context data for user risk score history
"""
user_id = remove_empty_elements(args.get("user_id"))
params = get_pagination(args)
response = client.kmsat_users_risk_score_history(user_id, params)
markdown = tableToMarkdown(
"Users Risk Score History", response, headers=["risk_score", "date"]
)
return CommandResults(
outputs_prefix="KMSAT.UsersRiskScoreHistory",
outputs_key_field="",
raw_response=response,
outputs=response,
readable_output=markdown,
)
def kmsat_phishing_security_tests_list_command(
client: Client, args: dict
) -> CommandResults:
""" Lists phishing security tests
Args:
client (Client): Report Client
args (dict): Params for phishing security tests
Raises:
DemistoException: Raises Demisto Exception
Returns:
CommandResults: Returns context data for phishing security
"""
params = get_pagination(args)
response = client.kmsat_phishing_security_tests(params)
markdown = tableToMarkdown(
"Phishing Security Tests",
response,
[
"campaign_id",
"pst_id",
"status",
"name",
"scheduled_count",
"delivered_count",
"opened_count",
"clicked_count",
"replied_count",
"attachment_open_count",
"macro_enabled_count",
"data_entered_count",
"qr_code_scanned_count",
"reported_count",
"bounced_count",
],
)
return CommandResults(
outputs_prefix="KMSAT.PhishingSecurity",
outputs_key_field="campaign_id",
raw_response=response,
outputs=response,
readable_output=markdown,
)
def kmsat_phishing_security_tests_recipients_list_command(
client: Client, args: dict
) -> CommandResults:
""" Lists KMSAT recipients phishing security tests
Args:
client (Client): Report Client
args (_type_): Params for recipients phishing security tests
Raises:
DemistoException: Raises Demisto Exception
Returns:
CommandResults: Returns context data for recipients phishing security tests
"""
pst_id = remove_empty_elements(args.get("pst_id"))
params = get_pagination(args)
response = client.kmsat_phishing_security_tests_recipients(pst_id, params)
markdown = tableToMarkdown(
"Phishing Security Tests Recipients",
response,
[
"recipient_id",
"pst_id",
"user",
"delivered_at",
"opened_at",
"clicked_at",
"replied_at",
"attachment_opened_at",
"macro_enabled_at",
"data_entered_at",
"qr_code_scanned",
"reported_at",
"bounced_at",
],
)
return CommandResults(
outputs_prefix="KMSAT.PhishingSecurityPST",
outputs_key_field="recipient_id",
raw_response=response,
outputs=response,
readable_output=markdown,
)
def kmsat_phishing_security_tests_failed_recipients_list_command(
client: Client, args: dict
) -> CommandResults:
""" Lists KMSAT recipients that have FAILED the phishing security tests
Args:
client (Client): Report Client
args (dict): Params for recipients that failed security tests
Raises:
DemistoException: Raises Demisto Exception
Returns:
CommandResults: Returns context data for recipients that failed phishing security tests
"""
pst_id = remove_empty_elements(args.get("pst_id"))
params = get_pagination(args)
response = client.kmsat_phishing_security_tests_recipients(pst_id, params)
filtered_items_in_page = 0
items_total = len(response)
# Sets paging_end False if the response count is less than the per_page
per_page = int(params.get('per_page')) if (params.get('per_page')) else 100
paging_end = len(response) < per_page
data = []
for i in range(len(response)):
clicked_at = response[i]['clicked_at']
replied_at = response[i]['replied_at']
attachment_opened_at = response[i]['attachment_opened_at']
macro_enabled_at = response[i]['macro_enabled_at']
data_entered_at = response[i]['data_entered_at']
qr_code_scanned = response[i]['qr_code_scanned']
if any([clicked_at, replied_at, attachment_opened_at, macro_enabled_at, data_entered_at, qr_code_scanned]):
data.append(response[i])
filtered_items_in_page += 1
# Adds meta to the result set for paging
metadata = {
"paging_end": paging_end,
"filtered_items_in_page": filtered_items_in_page,
"items_total": items_total
}
d = {
"data": data,
"meta": metadata
}
markdown = tableToMarkdown(
"Phishing Security Tests Recipients",
d["data"],
[
"recipient_id",
"pst_id",
"user",
"delivered_at",
"opened_at",
"clicked_at",
"replied_at",
"attachment_opened_at",
"macro_enabled_at",
"data_entered_at",
"qr_code_scanned",
"reported_at",
"bounced_at",
],
)
return CommandResults(
outputs_prefix="KMSAT.PhishingSecurityPST",
outputs_key_field="recipient_id",
raw_response=d,
outputs=d,
readable_output=markdown,
)
def kmsat_phishing_campaign_security_tests_list_command(client: Client, args) -> CommandResults:
""" Lists KMSAT campaign phishing security tets
Args:
client (Client): Report Client
args (_type_): Params for campaign phishing security tests
Raises:
DemistoException: Raises Demisto Exception
Returns:
CommandResults: Returns context data for phishing campaign security tests
"""
campaign_id = remove_empty_elements(args.get("campaign_id"))
params = get_pagination(args)
response = client.kmsat_phishing_campaign_security_tests(campaign_id, params)
markdown = tableToMarkdown(
"Phishing Campaign Security Tests",
response,
[
"campaign_id",
"pst_id",
"status",
"started_at",
"scheduled_count",
"delivered_count",
"opened_count",
"clicked_count",
"replied_count",
"attachment_open_count",
"macro_enabled_count",
"data_entered_count",
"qr_code_scanned_count",
"reported_count",
"bounced_count",
]
)
return CommandResults(
outputs_prefix="KMSAT.CampaignPST",
outputs_key_field="",
raw_response=response,
outputs=response,
readable_output=markdown,
)
def kmsat_training_campaigns_list_command(client: Client, args: dict) -> CommandResults:
""" Lists KMSAT training campaigns
Args:
client (Client): Report Client
args (dict): Params for training campaigns
Raises:
DemistoException: Raises Demisto Exception
Returns:
CommandResults: Returns context data for training campaigns
"""
params = get_pagination(args)
response = client.kmsat_training_campaigns(params)
markdown = tableToMarkdown(
"Training Campaigns",
response,
[
"campaign_id",
"name",
"groups",
"status",
"content",
"duration_type",
"start_date",
"end_date",
"relative_duration",
"auto_enroll",
"allow_multiple_enrollments",
"completion_percentage",
],
)
return CommandResults(
outputs_prefix="KMSAT.TrainingCampaigns",
outputs_key_field="campaign_id",
raw_response=response,
outputs=response,
readable_output=markdown,
)
def kmsat_training_enrollments_list_command(
client: Client, args: dict
) -> CommandResults:
""" Lists KMSAT training enrollments
Args:
client (Client): Report Client
args (dict): Params for training enrollments
Raises:
DemistoException: Raises Demisto Exception
Returns:
CommandResults: Returns context data for training enrollments
"""
status = remove_empty_elements(args.get("status"))
params = get_pagination(args)
response = client.kmsat_training_enrollments(params)
data = []
filtered_items_in_page = 0
items_total = len(response)
# Sets paging_end False if the response count is less than the per_page
per_page = int(params.get('per_page')) if (params.get('per_page')) else 100
paging_end = len(response) < per_page
# Adds only the filtered items to the response with counts
if status is not None:
for i in range(len(response)):
if response[i]['status'] == f"{status}":
data.append(response[i])
filtered_items_in_page += 1
else:
data = client.kmsat_training_enrollments(params)
# Adds meta to the result set for paging
metadata = {
"paging_end": paging_end,
"filtered_items_in_page": filtered_items_in_page,
"items_total": items_total
}
d = {
"data": data,
"meta": metadata
}
markdown = tableToMarkdown(
"Training Enrollments",
d["data"],
[
"enrollment_id",
"content_type",
"module_name",
"user",
"campaign_name",
"enrollment_date",
"start_date",
"completion_date",
"status",
"time_spent",
"policy_acknowledged",
]
)
return CommandResults(
outputs_prefix="KMSAT.TrainingEnrollments",
outputs_key_field="enrollment_id",
raw_response=d,
outputs=d,
readable_output=markdown,
)
def kmsat_user_events_list_command(
client: UserEventClient, args: dict
) -> CommandResults:
""" Lists the user events
Args:
client (UserEventClient): UserEventClient
args (dict): Params for user events
Raises:
DemistoException: Raises Demisto Exception