-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapi_spec.yaml
More file actions
3960 lines (3907 loc) · 120 KB
/
api_spec.yaml
File metadata and controls
3960 lines (3907 loc) · 120 KB
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
openapi: 3.0.0
components:
examples: {}
headers: {}
parameters: {}
requestBodies: {}
responses: {}
schemas:
PageInfo:
description: Provides information about the pagination of a dataset.
properties:
endCursor:
type: string
nullable: true
description:
The cursor that points to the end of the current page, or null if
there is no such cursor.
hasNextPage:
type: boolean
description: Indicates if there is another page after the current page.
hasPreviousPage:
type: boolean
description: Indicates if there is a page before the current page.
startCursor:
type: string
nullable: true
description:
The cursor that points to the start of the current page, or null if
there is no such cursor.
required:
- endCursor
- hasNextPage
- hasPreviousPage
- startCursor
type: object
additionalProperties: false
AuditFocus:
type: string
enum:
- EXTERNAL
- INTERNAL
Audit:
properties:
id:
type: string
description: The unique identifier for the audit.
customerOrganizationName:
type: string
description:
The domain name of the customer organization being audited (e.g.
vanta.com)
customerDisplayName:
type: string
nullable: true
description:
The human readable name of the customer organization being audited
(e.g. Vanta)
customerOrganizationId:
type: string
description: The uuid of the customer organization being audited
auditStartDate:
type: string
format: date-time
description:
The start of the audit window. This is also when data collection
for audit starts.
auditEndDate:
type: string
format: date-time
description: The end of the audit window.
earlyAccessStartsAt:
type: string
format: date-time
nullable: true
description:
Timestamp at which auditors gain access to the audit. Occurs before
the audit window begins
framework:
type: string
description: The name of the framework for the audit
allowAuditorEmails:
items:
type: string
type: array
description: Emails of auditors with access to audit
allowAllAuditors:
type: boolean
description: Set to true if all auditors in audit firm have access
deletionDate:
type: string
format: date-time
nullable: true
description: Timestamp when the audit was deleted
creationDate:
type: string
format: date-time
description: Timestamp when the audit was created
modificationDate:
type: string
format: date-time
nullable: true
description: Timestamp when the audit was updated
completionDate:
type: string
format: date-time
nullable: true
description:
Timestamp when the audit was marked completed, and report was
uploaded
auditFocus:
$ref: "#/components/schemas/AuditFocus"
description: The focus of the audit
required:
- id
- customerOrganizationName
- customerDisplayName
- customerOrganizationId
- auditStartDate
- auditEndDate
- earlyAccessStartsAt
- framework
- allowAuditorEmails
- allowAllAuditors
- deletionDate
- creationDate
- modificationDate
- completionDate
- auditFocus
type: object
additionalProperties: false
PaginatedResponse_Audit_:
properties:
results:
properties:
data:
items:
$ref: "#/components/schemas/Audit"
type: array
pageInfo:
$ref: "#/components/schemas/PageInfo"
required:
- data
- pageInfo
type: object
required:
- results
type: object
additionalProperties: false
ListAuditsPageSize:
type: integer
format: int32
default: 10
description: >-
Controls the maximum number of items returned in one response from the
listAudits API.
We have increased the pagination size for this endpoint to enable our
upmarket audit firms to
sync in a timely manner. The rest of the API will use a pagination size
of 100.
minimum: 1
maximum: 200
PageCursor:
type: string
description: >-
A marker or pointer, telling the API where to start fetching items for
the subsequent page in a paginated dataset.
Note that the requested page will not include the item that corresponds
to this cursor but will start from the one immediately
after this cursor.
VendorAuthenticationMethod:
description: >-
The authentication method a vendor uses:
- AUTH_0: The vendor authenticates using Auth0
- AZURE_AD: The vendor authenticates using Azure Active Directory
- G_SUITE: The vendor authenticates using Google Workspace
- O_AUTH: The vendor authenticates using OAuth
- O365: The vendor authenticates using Office 365
- OKTA: The vendor authenticates using Okta
- ONE_LOGIN: The vendor authenticates using OneLogin
- OWA: The vendor authenticates using OWA
- SSO: The vendor authenticates using SSO
- USERNAME_PASSWORD: The vendor authenticates using usernames and
passwords
enum:
- AUTH_0
- AZURE_AD
- GOOGLE_WORKSPACE
- O_AUTH
- O365
- OKTA
- ONE_LOGIN
- OWA
- SSO
- USERNAME_PASSWORD
type: string
VendorStatus:
description: |-
The current state of a vendor:
- MANAGED: The vendor is actively managed.
- ARCHIVED: The vendor has been archived
- IN_PROCUREMENT: The vendor is in the procurement process
enum:
- MANAGED
- ARCHIVED
- IN_PROCUREMENT
type: string
VendorRiskLevel:
description: |-
The risk level of a vendor:
- CRITICAL: The vendor has a critical security risk
- HIGH: The vendor has a high security risk
- MEDIUM: The vendor has a medium security risk
- LOW: The vendor has a low security risk
- UNSCORED: The vendor has not been given a risk level
enum:
- CRITICAL
- HIGH
- LOW
- MEDIUM
- UNSCORED
type: string
CountryCode:
enum:
- EUE
- AND
- ARE
- AFG
- ATG
- AIA
- ALB
- ARM
- AGO
- ATA
- ARG
- ASM
- AUT
- AUS
- ABW
- ALA
- AZE
- BIH
- BRB
- BGD
- BEL
- BFA
- BGR
- BHR
- BDI
- BEN
- BLM
- BMU
- BRN
- BOL
- BES
- BRA
- BHS
- BTN
- BVT
- BWA
- BLR
- BLZ
- CAN
- CCK
- COD
- CAF
- COG
- CHE
- CIV
- COK
- CHL
- CMR
- CHN
- COL
- CRI
- CUB
- CPV
- CUW
- CXR
- CYP
- CZE
- DEU
- DJI
- DNK
- DMA
- DOM
- DZA
- ECU
- EST
- EGY
- ESH
- ERI
- ESP
- ETH
- FIN
- FJI
- FLK
- FSM
- FRO
- FRA
- GAB
- ENG
- SCT
- GBR
- WAL
- NIR
- GRD
- GEO
- GUF
- GGY
- GHA
- GIB
- GRL
- GMB
- GIN
- GLP
- GNQ
- GRC
- SGS
- GTM
- GUM
- GNB
- GUY
- HKG
- HMD
- HND
- HRV
- HTI
- HUN
- IDN
- IRL
- ISR
- IMN
- IND
- IOT
- IRQ
- IRN
- ISL
- ITA
- JEY
- JAM
- JOR
- JPN
- KEN
- KGZ
- KHM
- KIR
- COM
- KNA
- PRK
- KOR
- KWT
- CYM
- KAZ
- LAO
- LBN
- LCA
- LIE
- LKA
- LBR
- LSO
- LTU
- LUX
- LVA
- LBY
- MAR
- MCO
- MDA
- MNE
- MAF
- MDG
- MHL
- MKD
- MLI
- MMR
- MNG
- MAC
- MNP
- MTQ
- MRT
- MSR
- MLT
- MUS
- MDV
- MWI
- MEX
- MYS
- MOZ
- NAM
- NCL
- NER
- NFK
- NGA
- NIC
- NLD
- NOR
- NPL
- NRU
- NIU
- NZL
- OMN
- PAN
- PER
- PYF
- PNG
- PHL
- PAK
- POL
- SPM
- PCN
- PRI
- PSE
- PRT
- PLW
- PRY
- QAT
- REU
- ROU
- SRB
- RUS
- RWA
- SAU
- SLB
- SYC
- SDN
- SWE
- SGP
- SHN
- SVN
- SJM
- SVK
- SLE
- SMR
- SEN
- SOM
- SUR
- SSD
- STP
- SLV
- SXM
- SYR
- SWZ
- TCA
- TCD
- ATF
- TGO
- THA
- TJK
- TKL
- TLS
- TKM
- TUN
- TON
- TUR
- TTO
- TUV
- TWN
- TZA
- UKR
- UGA
- UMI
- USA
- URY
- UZB
- VAT
- VCT
- VEN
- VGB
- VIR
- VNM
- VUT
- WLF
- WSM
- YEM
- MYT
- ZAF
- ZMB
- ZWE
type: string
CurrencyCode:
enum:
- ARS
- AUD
- BRL
- CAD
- COP
- CZK
- DKK
- EUR
- GBP
- ILS
- INR
- JPY
- MXN
- NOK
- NZD
- PHP
- PKR
- PLN
- RSD
- SEK
- SGD
- UAH
- USD
- ZAR
type: string
VendorContractAmount:
properties:
amount:
type: number
format: double
description: The amount of the contract.
currency:
$ref: "#/components/schemas/CurrencyCode"
description: The currency of the contract.
required:
- amount
- currency
type: object
additionalProperties: false
CustomField:
properties:
label:
type: string
value:
anyOf:
- type: string
- items:
type: string
type: array
required:
- label
- value
type: object
additionalProperties: false
Vendor:
properties:
id:
type: string
description: The vendor's unique ID.
name:
type: string
description: The vendor's display name.
websiteUrl:
type: string
nullable: true
description: The vendor's website URL.
accountManagerName:
type: string
nullable: true
description: The vendor's external account manager name.
accountManagerEmail:
type: string
nullable: true
description: The vendor's external account manager email.
servicesProvided:
type: string
nullable: true
description: Services provided by the vendor.
additionalNotes:
type: string
nullable: true
description: Any additional notes about the vendor
securityOwnerUserId:
type: string
nullable: true
description: The vendor's security owner's Vanta user ID.
businessOwnerUserId:
type: string
nullable: true
description: The vendor's business owner's Vanta user ID.
contractStartDate:
type: string
format: date-time
nullable: true
description: The date the contract with the vendor began.
contractRenewalDate:
type: string
format: date-time
nullable: true
description: The date the contract with the vendor is up for renewal.
contractTerminationDate:
type: string
format: date-time
nullable: true
description: The date the contract with the vendor was terminated.
nextSecurityReviewDueDate:
type: string
format: date-time
nullable: true
description: The next due date for a security review.
lastSecurityReviewCompletionDate:
type: string
format: date-time
nullable: true
description: The most recent date a security review was completed.
isVisibleToAuditors:
type: boolean
nullable: true
description: Whether or not auditors can view this vendor.
isRiskAutoScored:
type: boolean
nullable: true
description: Whether or not the vendor's risk is automatically scored.
riskAttributeIds:
items:
type: string
type: array
description: The list of risk attribute IDs the vendor has been assigned to.
category:
properties:
displayName:
type: string
required:
- displayName
type: object
nullable: true
description: The vendor's category.
authDetails:
properties:
passwordMinimumLength:
type: number
format: double
nullable: true
description: Minimum number for chacters required for passwords for this vendor.
passwordRequiresSymbol:
type: boolean
nullable: true
description: Whether or not the vendor requires passwords to have a symbol.
passwordRequiresNumber:
type: boolean
nullable: true
description: Whether or not the vendor requires passwords to have a number.
passwordMFA:
type: boolean
nullable: true
description:
Whether or not the vendor requires passwords to have multi factor
authentication.
method:
allOf:
- $ref: "#/components/schemas/VendorAuthenticationMethod"
nullable: true
description: The vendor's authentication method.
required:
- passwordMinimumLength
- passwordRequiresSymbol
- passwordRequiresNumber
- passwordMFA
- method
type: object
description: The vendor's authentication details.
status:
$ref: "#/components/schemas/VendorStatus"
description: The vendor's current status.
inherentRiskLevel:
$ref: "#/components/schemas/VendorRiskLevel"
description: The vendor's risk level.
residualRiskLevel:
$ref: "#/components/schemas/VendorRiskLevel"
description: The vendor's residual risk level.
vendorHeadquarters:
allOf:
- $ref: "#/components/schemas/CountryCode"
nullable: true
description: The vendor's headquarters.
contractAmount:
allOf:
- $ref: "#/components/schemas/VendorContractAmount"
nullable: true
description: The contract amount for the vendor.
customFields:
items:
$ref: "#/components/schemas/CustomField"
type: array
nullable: true
description: The vendor's custom fields.
required:
- id
- name
- websiteUrl
- accountManagerName
- accountManagerEmail
- servicesProvided
- additionalNotes
- securityOwnerUserId
- businessOwnerUserId
- contractStartDate
- contractRenewalDate
- contractTerminationDate
- nextSecurityReviewDueDate
- lastSecurityReviewCompletionDate
- isVisibleToAuditors
- isRiskAutoScored
- riskAttributeIds
- category
- authDetails
- status
- inherentRiskLevel
- residualRiskLevel
- vendorHeadquarters
- contractAmount
- customFields
type: object
additionalProperties: false
PaginatedResponse_Vendor_:
properties:
results:
properties:
data:
items:
$ref: "#/components/schemas/Vendor"
type: array
pageInfo:
$ref: "#/components/schemas/PageInfo"
required:
- data
- pageInfo
type: object
required:
- results
type: object
additionalProperties: false
PageSize:
type: integer
format: int32
default: 10
description:
Controls the maximum number of items returned in one response from
the API.
minimum: 1
maximum: 100
ComputerStatusOutcome:
description: >-
The possible outcomes of a status check. The outcome can be one of the
following:
FAIL: The check is failing.
IN_PROGRESS: The check needs further data from the given computer in
order to evaluate. The field(s) needed from a computer to calculate the
ComputerStatusOutcome were null.
NA: The check is not applicable for the given computer.
PASS: The check is passing.
enum:
- FAIL
- IN_PROGRESS
- NA
- PASS
type: string
ComputerStatus:
description:
The a status check for a computer. Representation for screenlock,
diskEncryption, passwordManager, and antivirusInstallation.
properties:
outcome:
$ref: "#/components/schemas/ComputerStatusOutcome"
description: The outcome of the status check.
required:
- outcome
type: object
additionalProperties: false
OperatingSystemType:
description: The possible types of the operating system. One of `mac_OS`,
`linux`, or `windows`.
enum:
- macOS
- linux
- windows
type: string
OperatingSystem:
description: The computer's operating system type and version.
properties:
type:
$ref: "#/components/schemas/OperatingSystemType"
description: The type of the operating system.
version:
type: string
nullable: true
description: The version of the operating system.
required:
- type
- version
type: object
additionalProperties: false
Owner:
properties:
id:
type: string
description: Unique identifier for the person.
displayName:
type: string
description: Name of the person that is shown in product.
emailAddress:
type: string
description: Email address of the person.
required:
- id
- displayName
- emailAddress
type: object
additionalProperties: false
MonitoredComputer:
properties:
id:
type: string
description: Unique identifier for the monitored computer.
integrationId:
type: string
description:
Hard-coded enums for Vanta-built integrations or application IDs
for 3rd-party-built integrations.
lastCheckDate:
type: string
format: date-time
nullable: true
description: Date of the computer's most recent report.
screenlock:
$ref: "#/components/schemas/ComputerStatus"
description: Whether or not the computer has screenlock enabled.
diskEncryption:
$ref: "#/components/schemas/ComputerStatus"
description: Whether or not the computer's hard drive is encrypted.
passwordManager:
$ref: "#/components/schemas/ComputerStatus"
description: Whether or not the computer has a password manager installed.
antivirusInstallation:
$ref: "#/components/schemas/ComputerStatus"
description: Whether or not the computer has antivirus software installed.
operatingSystem:
allOf:
- $ref: "#/components/schemas/OperatingSystem"
nullable: true
description: The computer's operating system name and version.
owner:
allOf:
- $ref: "#/components/schemas/Owner"
nullable: true
description:
The name, unique identifier, and email address of the computer's
owner.
serialNumber:
type: string
nullable: true
description:
The serial number of the computer. This value may be null if it is
not reported by the device.
udid:
type: string
nullable: true
description: The universal device id of the computer.
required:
- id
- integrationId
- lastCheckDate
- screenlock
- diskEncryption
- passwordManager
- antivirusInstallation
- operatingSystem
- owner
- serialNumber
- udid
type: object
additionalProperties: false
PaginatedResponse_MonitoredComputer_:
properties:
results:
properties:
data:
items:
$ref: "#/components/schemas/MonitoredComputer"
type: array
pageInfo:
$ref: "#/components/schemas/PageInfo"
required:
- data
- pageInfo
type: object
required:
- results
type: object
additionalProperties: false
ComputerStatusFilter:
description: >-
Enum representing computer compliance statuses that can be utilized as a
filter. The meanings are as follows:
AV_NOT_INSTALLED: The computer does not have antivirus software
installed.
HD_NOT_ENCRYPTED: The computer's harddrive is not encrypted.
LAST_CHECK_OVER_14_DAYS: No data has been received from computer for
over 14 days.
PWM_NOT_INSTALLED: The computer does not have a password manager
installed.
SCREENLOCK_NOT_CONFIGURED: The computer does not have screenlock
configured appropriately.
enum:
- PWM_NOT_INSTALLED
- HD_NOT_ENCRYPTED
- AV_NOT_INSTALLED
- SCREENLOCK_NOT_CONFIGURED
- LAST_CHECK_OVER_14_DAYS
type: string
EvidenceUrl:
properties:
id:
type: string
description: Vanta internal reference to evidence
url:
type: string
description: Pre-signed S3 URL for evidence
filename:
type: string
description: File name of evidence
isDownloadable:
type: boolean
description:
Set to true if this is a presigned s3 url. Set to false if this is
a customer uploaded link
required:
- id
- url
- filename
- isDownloadable
type: object
additionalProperties: false
PaginatedResponse_EvidenceUrl_:
properties:
results:
properties:
data:
items:
$ref: "#/components/schemas/EvidenceUrl"
type: array
pageInfo:
$ref: "#/components/schemas/PageInfo"
required:
- data
- pageInfo
type: object
required:
- results
type: object
additionalProperties: false
EmploymentStatus:
description: >-
The employment status of a person:
- UPCOMING: The person is not yet employed and will start employment in
the future.
- CURRENT: The person is currently employed.
- ON_LEAVE: The person is on leave.
- INACTIVE: The person's employment is inactive.
- FORMER: The person was previously employed.
enum:
- UPCOMING
- CURRENT
- ON_LEAVE
- INACTIVE
- FORMER
type: string
LeaveStatus:
description: User can be active or upcoming leave period
enum:
- ACTIVE
- UPCOMING
type: string
LeaveInfo:
properties:
startDate:
type: string
format: date-time
description: The start of the person's leave.
endDate:
type: string