@itentialopensource/adapter-digicert_pki 1.0.0 → 1.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (43) hide show
  1. package/.eslintignore +0 -1
  2. package/.jshintrc +3 -0
  3. package/CALLS.md +162 -453
  4. package/CHANGELOG.md +16 -0
  5. package/CONTRIBUTING.md +1 -160
  6. package/ENHANCE.md +2 -2
  7. package/README.md +31 -22
  8. package/adapter.js +159 -330
  9. package/adapterBase.js +538 -873
  10. package/changelogs/changelog.md +16 -0
  11. package/metadata.json +49 -0
  12. package/package.json +22 -25
  13. package/pronghorn.json +474 -142
  14. package/propertiesSchema.json +455 -42
  15. package/refs?service=git-upload-pack +0 -0
  16. package/report/adapter-openapi.json +3224 -0
  17. package/report/adapter-openapi.yaml +2185 -0
  18. package/report/adapterInfo.json +8 -8
  19. package/report/updateReport1691508686598.json +120 -0
  20. package/report/updateReport1692203137726.json +120 -0
  21. package/report/updateReport1694467869659.json +120 -0
  22. package/report/updateReport1698422457936.json +120 -0
  23. package/sampleProperties.json +64 -3
  24. package/test/integration/adapterTestBasicGet.js +1 -1
  25. package/test/integration/adapterTestConnectivity.js +91 -42
  26. package/test/integration/adapterTestIntegration.js +275 -147
  27. package/test/unit/adapterBaseTestUnit.js +388 -313
  28. package/test/unit/adapterTestUnit.js +519 -322
  29. package/utils/adapterInfo.js +1 -1
  30. package/utils/addAuth.js +1 -1
  31. package/utils/artifactize.js +1 -1
  32. package/utils/checkMigrate.js +1 -1
  33. package/utils/entitiesToDB.js +1 -0
  34. package/utils/findPath.js +1 -1
  35. package/utils/methodDocumentor.js +71 -23
  36. package/utils/modify.js +13 -15
  37. package/utils/packModificationScript.js +1 -1
  38. package/utils/taskMover.js +309 -0
  39. package/utils/tbScript.js +3 -10
  40. package/utils/tbUtils.js +2 -3
  41. package/utils/testRunner.js +1 -1
  42. package/utils/troubleshootingAdapter.js +1 -3
  43. package/workflows/README.md +0 -3
package/report/adapter-openapi.json ADDED
@@ -0,0 +1,3224 @@
1
+ {
2
+ "openapi": "3.0.0",
3
+ "info": {
4
+ "title": "DigiCert PKI Platform Rest APIs",
5
+ "description": "This document specifies the APIs that user can implement to consume DigiCert PKI platform web services. It details a set of RESTful APIs to allow issuance, management of certificates and users.",
6
+ "contact": {},
7
+ "version": "1.0.44"
8
+ },
9
+ "servers": [
10
+ {
11
+ "url": "http://pki-ws-rest.symauth.com/mpki",
12
+ "variables": {}
13
+ }
14
+ ],
15
+ "paths": {
16
+ "/api/v1/audit-log": {
17
+ "get": {
18
+ "tags": [
19
+ "Audit API"
20
+ ],
21
+ "summary": "getAuditsUsingGET",
22
+ "description": "This API is used to get audit details for given query param",
23
+ "operationId": "getAuditsUsingGET",
24
+ "parameters": [
25
+ {
26
+ "name": "X-API-Key",
27
+ "in": "header",
28
+ "description": "",
29
+ "style": "simple",
30
+ "schema": {
31
+ "type": "string"
32
+ }
33
+ },
34
+ {
35
+ "name": "action",
36
+ "in": "query",
37
+ "description": "Available values : USER_ENROLLED, USER_INFO_EDIT, USER_CREATED , USER_DELETED etc.\nPlease refer API Docs for available values.",
38
+ "style": "form",
39
+ "explode": true,
40
+ "schema": {
41
+ "type": "array",
42
+ "items": {
43
+ "type": "string"
44
+ }
45
+ }
46
+ },
47
+ {
48
+ "name": "adminRA",
49
+ "in": "query",
50
+ "description": "Administrator userName or RA common name",
51
+ "style": "form",
52
+ "explode": true,
53
+ "schema": {
54
+ "type": "array",
55
+ "items": {
56
+ "type": "string"
57
+ }
58
+ }
59
+ },
60
+ {
61
+ "name": "dateFrom",
62
+ "in": "query",
63
+ "description": "Datetime in ISO format",
64
+ "required": true,
65
+ "style": "form",
66
+ "explode": true,
67
+ "schema": {
68
+ "type": "string"
69
+ }
70
+ },
71
+ {
72
+ "name": "dateTo",
73
+ "in": "query",
74
+ "description": "Datetime in ISO format. Time span from dateFrom cannot exceed 365 days.",
75
+ "required": true,
76
+ "style": "form",
77
+ "explode": true,
78
+ "schema": {
79
+ "type": "string"
80
+ }
81
+ },
82
+ {
83
+ "name": "limit",
84
+ "in": "query",
85
+ "description": "Default Limit is 100",
86
+ "style": "form",
87
+ "explode": true,
88
+ "schema": {
89
+ "type": "integer",
90
+ "format": "int32",
91
+ "example": 10
92
+ }
93
+ },
94
+ {
95
+ "name": "offset",
96
+ "in": "query",
97
+ "description": "Default value is 0",
98
+ "style": "form",
99
+ "explode": true,
100
+ "schema": {
101
+ "type": "integer",
102
+ "format": "int32",
103
+ "example": 0
104
+ }
105
+ }
106
+ ],
107
+ "responses": {
108
+ "200": {
109
+ "description": "OK",
110
+ "headers": {},
111
+ "content": {
112
+ "application/json": {
113
+ "schema": {
114
+ "type": "object"
115
+ }
116
+ }
117
+ }
118
+ },
119
+ "401": {
120
+ "description": "Unauthorized",
121
+ "headers": {},
122
+ "content": {}
123
+ },
124
+ "403": {
125
+ "description": "Forbidden",
126
+ "headers": {},
127
+ "content": {}
128
+ },
129
+ "404": {
130
+ "description": "Not Found",
131
+ "headers": {},
132
+ "content": {}
133
+ }
134
+ },
135
+ "deprecated": false
136
+ }
137
+ },
138
+ "/api/v1/audit-log/{auditId}": {
139
+ "get": {
140
+ "tags": [
141
+ "Audit API"
142
+ ],
143
+ "summary": "getAuditUsingGET",
144
+ "description": "This API is used to get audit details for given audit Id.",
145
+ "operationId": "getAuditUsingGET",
146
+ "parameters": [
147
+ {
148
+ "name": "X-API-Key",
149
+ "in": "header",
150
+ "description": "",
151
+ "style": "simple",
152
+ "schema": {
153
+ "type": "string"
154
+ }
155
+ },
156
+ {
157
+ "name": "auditId",
158
+ "in": "path",
159
+ "description": "auditId",
160
+ "required": true,
161
+ "style": "simple",
162
+ "schema": {
163
+ "type": "integer",
164
+ "format": "int64"
165
+ }
166
+ }
167
+ ],
168
+ "responses": {
169
+ "200": {
170
+ "description": "OK",
171
+ "headers": {},
172
+ "content": {
173
+ "application/json": {
174
+ "schema": {
175
+ "type": "object"
176
+ }
177
+ }
178
+ }
179
+ },
180
+ "401": {
181
+ "description": "Unauthorized",
182
+ "headers": {},
183
+ "content": {}
184
+ },
185
+ "403": {
186
+ "description": "Forbidden",
187
+ "headers": {},
188
+ "content": {}
189
+ },
190
+ "404": {
191
+ "description": "Not Found",
192
+ "headers": {},
193
+ "content": {}
194
+ }
195
+ },
196
+ "deprecated": false
197
+ }
198
+ },
199
+ "/api/v1/ca/id/{caId}": {
200
+ "get": {
201
+ "tags": [
202
+ "CA API"
203
+ ],
204
+ "summary": "getCAInfoUsingGET",
205
+ "description": "This API is used to get public CA details for a given ca identifier",
206
+ "operationId": "getCAInfoUsingGET",
207
+ "parameters": [
208
+ {
209
+ "name": "X-API-Key",
210
+ "in": "header",
211
+ "description": "",
212
+ "style": "simple",
213
+ "schema": {
214
+ "type": "string"
215
+ }
216
+ },
217
+ {
218
+ "name": "caId",
219
+ "in": "path",
220
+ "description": "caId",
221
+ "required": true,
222
+ "style": "simple",
223
+ "schema": {
224
+ "type": "string"
225
+ }
226
+ }
227
+ ],
228
+ "responses": {
229
+ "200": {
230
+ "description": "OK",
231
+ "headers": {},
232
+ "content": {
233
+ "application/json": {
234
+ "schema": {
235
+ "type": "object"
236
+ }
237
+ }
238
+ }
239
+ },
240
+ "401": {
241
+ "description": "Unauthorized",
242
+ "headers": {},
243
+ "content": {}
244
+ },
245
+ "403": {
246
+ "description": "Forbidden",
247
+ "headers": {},
248
+ "content": {}
249
+ },
250
+ "404": {
251
+ "description": "Not Found",
252
+ "headers": {},
253
+ "content": {}
254
+ }
255
+ },
256
+ "deprecated": false
257
+ }
258
+ },
259
+ "/api/v1/ca/{seatType}": {
260
+ "get": {
261
+ "tags": [
262
+ "CA API"
263
+ ],
264
+ "summary": "getCAUsingGET",
265
+ "description": "This API is used to get public CA details for a given account api key",
266
+ "operationId": "getCAUsingGET",
267
+ "parameters": [
268
+ {
269
+ "name": "X-API-Key",
270
+ "in": "header",
271
+ "description": "",
272
+ "style": "simple",
273
+ "schema": {
274
+ "type": "string"
275
+ }
276
+ },
277
+ {
278
+ "name": "seatType",
279
+ "in": "path",
280
+ "description": "seatType",
281
+ "required": true,
282
+ "style": "simple",
283
+ "schema": {
284
+ "type": "string"
285
+ }
286
+ }
287
+ ],
288
+ "responses": {
289
+ "200": {
290
+ "description": "OK",
291
+ "headers": {},
292
+ "content": {
293
+ "application/json": {
294
+ "schema": {
295
+ "type": "object"
296
+ }
297
+ }
298
+ }
299
+ },
300
+ "401": {
301
+ "description": "Unauthorized",
302
+ "headers": {},
303
+ "content": {}
304
+ },
305
+ "403": {
306
+ "description": "Forbidden",
307
+ "headers": {},
308
+ "content": {}
309
+ },
310
+ "404": {
311
+ "description": "Not Found",
312
+ "headers": {},
313
+ "content": {}
314
+ }
315
+ },
316
+ "deprecated": false
317
+ }
318
+ },
319
+ "/api/v1/certificate": {
320
+ "post": {
321
+ "tags": [
322
+ "Certificate Enrollment API"
323
+ ],
324
+ "summary": "enrollCertificateUsingPOST",
325
+ "description": "This API is used to enroll a certificate for a given profile.",
326
+ "operationId": "enrollCertificateUsingPOST",
327
+ "parameters": [
328
+ {
329
+ "name": "X-API-Key",
330
+ "in": "header",
331
+ "description": "",
332
+ "style": "simple",
333
+ "schema": {
334
+ "type": "string"
335
+ }
336
+ }
337
+ ],
338
+ "requestBody": {
339
+ "description": "enrollCertificateRequest",
340
+ "content": {
341
+ "application/json": {
342
+ "schema": {
343
+ "allOf": [
344
+ {
345
+ "$ref": "#/components/schemas/RequestCertificateRequest"
346
+ },
347
+ {
348
+ "description": "enrollCertificateRequest"
349
+ }
350
+ ]
351
+ }
352
+ }
353
+ },
354
+ "required": true
355
+ },
356
+ "responses": {
357
+ "200": {
358
+ "description": "OK",
359
+ "headers": {},
360
+ "content": {
361
+ "application/json": {
362
+ "schema": {
363
+ "type": "object"
364
+ }
365
+ }
366
+ }
367
+ },
368
+ "201": {
369
+ "description": "Created",
370
+ "headers": {},
371
+ "content": {}
372
+ },
373
+ "401": {
374
+ "description": "Unauthorized",
375
+ "headers": {},
376
+ "content": {}
377
+ },
378
+ "403": {
379
+ "description": "Forbidden",
380
+ "headers": {},
381
+ "content": {}
382
+ },
383
+ "404": {
384
+ "description": "Not Found",
385
+ "headers": {},
386
+ "content": {}
387
+ }
388
+ },
389
+ "deprecated": false
390
+ }
391
+ },
392
+ "/api/v1/certificate/create": {
393
+ "post": {
394
+ "tags": [
395
+ "Certificate Enrollment API"
396
+ ],
397
+ "summary": "createCertificateUsingPOST",
398
+ "description": "This API is used to enroll a certificate for a given profile.",
399
+ "operationId": "createCertificateUsingPOST",
400
+ "parameters": [
401
+ {
402
+ "name": "X-API-Key",
403
+ "in": "header",
404
+ "description": "",
405
+ "style": "simple",
406
+ "schema": {
407
+ "type": "string"
408
+ }
409
+ }
410
+ ],
411
+ "requestBody": {
412
+ "description": "enrollCertificateRequest",
413
+ "content": {
414
+ "application/json": {
415
+ "schema": {
416
+ "allOf": [
417
+ {
418
+ "$ref": "#/components/schemas/CreateCertificateRequest"
419
+ },
420
+ {
421
+ "description": "enrollCertificateRequest"
422
+ }
423
+ ]
424
+ }
425
+ }
426
+ },
427
+ "required": true
428
+ },
429
+ "responses": {
430
+ "200": {
431
+ "description": "OK",
432
+ "headers": {},
433
+ "content": {
434
+ "application/json": {
435
+ "schema": {
436
+ "type": "object"
437
+ }
438
+ }
439
+ }
440
+ },
441
+ "201": {
442
+ "description": "Created",
443
+ "headers": {},
444
+ "content": {}
445
+ },
446
+ "401": {
447
+ "description": "Unauthorized",
448
+ "headers": {},
449
+ "content": {}
450
+ },
451
+ "403": {
452
+ "description": "Forbidden",
453
+ "headers": {},
454
+ "content": {}
455
+ },
456
+ "404": {
457
+ "description": "Not Found",
458
+ "headers": {},
459
+ "content": {}
460
+ }
461
+ },
462
+ "deprecated": false
463
+ }
464
+ },
465
+ "/api/v1/certificate/renew/{serialNumber}": {
466
+ "post": {
467
+ "tags": [
468
+ "Certificate Enrollment API"
469
+ ],
470
+ "summary": "renewExternalCertificateUsingPOST",
471
+ "description": "This API is used to enroll a certificate for a given profile.",
472
+ "operationId": "renewExternalCertificateUsingPOST",
473
+ "parameters": [
474
+ {
475
+ "name": "X-API-Key",
476
+ "in": "header",
477
+ "description": "",
478
+ "style": "simple",
479
+ "schema": {
480
+ "type": "string"
481
+ }
482
+ },
483
+ {
484
+ "name": "serialNumber",
485
+ "in": "path",
486
+ "description": "serialNumber",
487
+ "required": true,
488
+ "style": "simple",
489
+ "schema": {
490
+ "type": "string"
491
+ }
492
+ }
493
+ ],
494
+ "requestBody": {
495
+ "description": "enrollCertificateRequest",
496
+ "content": {
497
+ "application/json": {
498
+ "schema": {
499
+ "allOf": [
500
+ {
501
+ "$ref": "#/components/schemas/CreateCertificateRequest"
502
+ },
503
+ {
504
+ "description": "enrollCertificateRequest"
505
+ }
506
+ ]
507
+ }
508
+ }
509
+ },
510
+ "required": true
511
+ },
512
+ "responses": {
513
+ "200": {
514
+ "description": "OK",
515
+ "headers": {},
516
+ "content": {
517
+ "application/json": {
518
+ "schema": {
519
+ "type": "object"
520
+ }
521
+ }
522
+ }
523
+ },
524
+ "201": {
525
+ "description": "Created",
526
+ "headers": {},
527
+ "content": {}
528
+ },
529
+ "401": {
530
+ "description": "Unauthorized",
531
+ "headers": {},
532
+ "content": {}
533
+ },
534
+ "403": {
535
+ "description": "Forbidden",
536
+ "headers": {},
537
+ "content": {}
538
+ },
539
+ "404": {
540
+ "description": "Not Found",
541
+ "headers": {},
542
+ "content": {}
543
+ }
544
+ },
545
+ "deprecated": false
546
+ }
547
+ },
548
+ "/api/v1/certificate/{serialNumber}": {
549
+ "get": {
550
+ "tags": [
551
+ "Certificate Enrollment API"
552
+ ],
553
+ "summary": "getCertificateUsingGET",
554
+ "description": "This API is used to get certificate details for a given certificate serial number",
555
+ "operationId": "getCertificateUsingGET",
556
+ "parameters": [
557
+ {
558
+ "name": "X-API-Key",
559
+ "in": "header",
560
+ "description": "",
561
+ "style": "simple",
562
+ "schema": {
563
+ "type": "string"
564
+ }
565
+ },
566
+ {
567
+ "name": "serialNumber",
568
+ "in": "path",
569
+ "description": "serialNumber",
570
+ "required": true,
571
+ "style": "simple",
572
+ "schema": {
573
+ "type": "string"
574
+ }
575
+ }
576
+ ],
577
+ "responses": {
578
+ "200": {
579
+ "description": "OK",
580
+ "headers": {},
581
+ "content": {
582
+ "application/json": {
583
+ "schema": {
584
+ "type": "object"
585
+ }
586
+ }
587
+ }
588
+ },
589
+ "401": {
590
+ "description": "Unauthorized",
591
+ "headers": {},
592
+ "content": {}
593
+ },
594
+ "403": {
595
+ "description": "Forbidden",
596
+ "headers": {},
597
+ "content": {}
598
+ },
599
+ "404": {
600
+ "description": "Not Found",
601
+ "headers": {},
602
+ "content": {}
603
+ }
604
+ },
605
+ "deprecated": false
606
+ }
607
+ },
608
+ "/api/v1/certificate/{serialNumber}/key": {
609
+ "get": {
610
+ "tags": [
611
+ "Certificate Enrollment API"
612
+ ],
613
+ "summary": "recoverKeyUsingGET",
614
+ "description": "This API is used to get private key information for key-escrowed certificate with given serial number",
615
+ "operationId": "recoverKeyUsingGET",
616
+ "parameters": [
617
+ {
618
+ "name": "X-API-Key",
619
+ "in": "header",
620
+ "description": "",
621
+ "style": "simple",
622
+ "schema": {
623
+ "type": "string"
624
+ }
625
+ },
626
+ {
627
+ "name": "serialNumber",
628
+ "in": "path",
629
+ "description": "serialNumber",
630
+ "required": true,
631
+ "style": "simple",
632
+ "schema": {
633
+ "type": "string"
634
+ }
635
+ }
636
+ ],
637
+ "responses": {
638
+ "200": {
639
+ "description": "OK",
640
+ "headers": {},
641
+ "content": {
642
+ "application/json": {
643
+ "schema": {
644
+ "type": "object"
645
+ }
646
+ }
647
+ }
648
+ },
649
+ "401": {
650
+ "description": "Unauthorized",
651
+ "headers": {},
652
+ "content": {}
653
+ },
654
+ "403": {
655
+ "description": "Forbidden",
656
+ "headers": {},
657
+ "content": {}
658
+ },
659
+ "404": {
660
+ "description": "Not Found",
661
+ "headers": {},
662
+ "content": {}
663
+ }
664
+ },
665
+ "deprecated": false
666
+ }
667
+ },
668
+ "/api/v1/certificate/{serialNumber}/renew": {
669
+ "post": {
670
+ "tags": [
671
+ "Certificate Enrollment API"
672
+ ],
673
+ "summary": "renewCertificateUsingPOST",
674
+ "description": "This API is used to renew certificate with the given serial number.",
675
+ "operationId": "renewCertificateUsingPOST",
676
+ "parameters": [
677
+ {
678
+ "name": "X-API-Key",
679
+ "in": "header",
680
+ "description": "",
681
+ "style": "simple",
682
+ "schema": {
683
+ "type": "string"
684
+ }
685
+ },
686
+ {
687
+ "name": "serialNumber",
688
+ "in": "path",
689
+ "description": "serialNumber",
690
+ "required": true,
691
+ "style": "simple",
692
+ "schema": {
693
+ "type": "string"
694
+ }
695
+ }
696
+ ],
697
+ "requestBody": {
698
+ "description": "enrollCertificateRequest",
699
+ "content": {
700
+ "application/json": {
701
+ "schema": {
702
+ "allOf": [
703
+ {
704
+ "$ref": "#/components/schemas/RequestCertificateRequest"
705
+ },
706
+ {
707
+ "description": "enrollCertificateRequest"
708
+ }
709
+ ]
710
+ }
711
+ }
712
+ },
713
+ "required": true
714
+ },
715
+ "responses": {
716
+ "200": {
717
+ "description": "OK",
718
+ "headers": {},
719
+ "content": {
720
+ "application/json": {
721
+ "schema": {
722
+ "type": "object"
723
+ }
724
+ }
725
+ }
726
+ },
727
+ "201": {
728
+ "description": "Created",
729
+ "headers": {},
730
+ "content": {}
731
+ },
732
+ "401": {
733
+ "description": "Unauthorized",
734
+ "headers": {},
735
+ "content": {}
736
+ },
737
+ "403": {
738
+ "description": "Forbidden",
739
+ "headers": {},
740
+ "content": {}
741
+ },
742
+ "404": {
743
+ "description": "Not Found",
744
+ "headers": {},
745
+ "content": {}
746
+ }
747
+ },
748
+ "deprecated": false
749
+ }
750
+ },
751
+ "/api/v1/certificate/{serialNumber}/revoke": {
752
+ "put": {
753
+ "tags": [
754
+ "Certificate Enrollment API"
755
+ ],
756
+ "summary": "revokeCertificateUsingPUT",
757
+ "description": "This API can revoke certificate with the given serial number",
758
+ "operationId": "revokeCertificateUsingPUT",
759
+ "parameters": [
760
+ {
761
+ "name": "X-API-Key",
762
+ "in": "header",
763
+ "description": "",
764
+ "style": "simple",
765
+ "schema": {
766
+ "type": "string"
767
+ }
768
+ },
769
+ {
770
+ "name": "serialNumber",
771
+ "in": "path",
772
+ "description": "serialNumber",
773
+ "required": true,
774
+ "style": "simple",
775
+ "schema": {
776
+ "type": "string"
777
+ }
778
+ }
779
+ ],
780
+ "requestBody": {
781
+ "description": "revokeCertificateRequest",
782
+ "content": {
783
+ "application/json": {
784
+ "schema": {
785
+ "allOf": [
786
+ {
787
+ "$ref": "#/components/schemas/RevokeCertificateRequest"
788
+ },
789
+ {
790
+ "description": "revokeCertificateRequest"
791
+ }
792
+ ]
793
+ }
794
+ }
795
+ },
796
+ "required": false
797
+ },
798
+ "responses": {
799
+ "200": {
800
+ "description": "OK",
801
+ "headers": {},
802
+ "content": {
803
+ "application/json": {
804
+ "schema": {
805
+ "type": "object"
806
+ }
807
+ }
808
+ }
809
+ },
810
+ "201": {
811
+ "description": "Created",
812
+ "headers": {},
813
+ "content": {}
814
+ },
815
+ "401": {
816
+ "description": "Unauthorized",
817
+ "headers": {},
818
+ "content": {}
819
+ },
820
+ "403": {
821
+ "description": "Forbidden",
822
+ "headers": {},
823
+ "content": {}
824
+ },
825
+ "404": {
826
+ "description": "Not Found",
827
+ "headers": {},
828
+ "content": {}
829
+ }
830
+ },
831
+ "deprecated": false
832
+ },
833
+ "delete": {
834
+ "tags": [
835
+ "Certificate Enrollment API"
836
+ ],
837
+ "summary": "unRevokeCertificateUsingDELETE",
838
+ "description": "This API can resume certificate with the given serial number.",
839
+ "operationId": "unRevokeCertificateUsingDELETE",
840
+ "parameters": [
841
+ {
842
+ "name": "X-API-Key",
843
+ "in": "header",
844
+ "description": "",
845
+ "style": "simple",
846
+ "schema": {
847
+ "type": "string"
848
+ }
849
+ },
850
+ {
851
+ "name": "serialNumber",
852
+ "in": "path",
853
+ "description": "serialNumber",
854
+ "required": true,
855
+ "style": "simple",
856
+ "schema": {
857
+ "type": "string"
858
+ }
859
+ }
860
+ ],
861
+ "responses": {
862
+ "200": {
863
+ "description": "OK",
864
+ "headers": {},
865
+ "content": {
866
+ "application/json": {
867
+ "schema": {
868
+ "type": "object"
869
+ }
870
+ }
871
+ }
872
+ },
873
+ "204": {
874
+ "description": "No Content",
875
+ "headers": {},
876
+ "content": {}
877
+ },
878
+ "401": {
879
+ "description": "Unauthorized",
880
+ "headers": {},
881
+ "content": {}
882
+ },
883
+ "403": {
884
+ "description": "Forbidden",
885
+ "headers": {},
886
+ "content": {}
887
+ }
888
+ },
889
+ "deprecated": false
890
+ }
891
+ },
892
+ "/api/v1/profile": {
893
+ "get": {
894
+ "tags": [
895
+ "Certificate Profile API"
896
+ ],
897
+ "summary": "getAllProfilesUsingGET",
898
+ "description": "This API is used to get profile details of all profiles in an account and its subaccounts",
899
+ "operationId": "getAllProfilesUsingGET",
900
+ "parameters": [
901
+ {
902
+ "name": "X-API-Key",
903
+ "in": "header",
904
+ "description": "",
905
+ "style": "simple",
906
+ "schema": {
907
+ "type": "string"
908
+ }
909
+ }
910
+ ],
911
+ "responses": {
912
+ "200": {
913
+ "description": "OK",
914
+ "headers": {},
915
+ "content": {
916
+ "application/json": {
917
+ "schema": {
918
+ "type": "array",
919
+ "items": {
920
+ "$ref": "#/components/schemas/GetProfileResponse"
921
+ },
922
+ "description": ""
923
+ }
924
+ }
925
+ }
926
+ },
927
+ "401": {
928
+ "description": "Unauthorized",
929
+ "headers": {},
930
+ "content": {}
931
+ },
932
+ "403": {
933
+ "description": "Forbidden",
934
+ "headers": {},
935
+ "content": {}
936
+ },
937
+ "404": {
938
+ "description": "Not Found",
939
+ "headers": {},
940
+ "content": {}
941
+ }
942
+ },
943
+ "deprecated": false
944
+ }
945
+ },
946
+ "/api/v1/profile/{profileId}": {
947
+ "get": {
948
+ "tags": [
949
+ "Certificate Profile API"
950
+ ],
951
+ "summary": "getProfileUsingGET",
952
+ "description": "This API is used to get profile details for a given profile id",
953
+ "operationId": "getProfileUsingGET",
954
+ "parameters": [
955
+ {
956
+ "name": "X-API-Key",
957
+ "in": "header",
958
+ "description": "",
959
+ "style": "simple",
960
+ "schema": {
961
+ "type": "string"
962
+ }
963
+ },
964
+ {
965
+ "name": "profileId",
966
+ "in": "path",
967
+ "description": "profileId",
968
+ "required": true,
969
+ "style": "simple",
970
+ "schema": {
971
+ "type": "string"
972
+ }
973
+ }
974
+ ],
975
+ "responses": {
976
+ "200": {
977
+ "description": "OK",
978
+ "headers": {},
979
+ "content": {
980
+ "application/json": {
981
+ "schema": {
982
+ "$ref": "#/components/schemas/GetProfileResponse"
983
+ }
984
+ }
985
+ }
986
+ },
987
+ "401": {
988
+ "description": "Unauthorized",
989
+ "headers": {},
990
+ "content": {}
991
+ },
992
+ "403": {
993
+ "description": "Forbidden",
994
+ "headers": {},
995
+ "content": {}
996
+ },
997
+ "404": {
998
+ "description": "Not Found",
999
+ "headers": {},
1000
+ "content": {}
1001
+ }
1002
+ },
1003
+ "deprecated": false
1004
+ }
1005
+ },
1006
+ "/api/v1/enrollstatus/{seatId}": {
1007
+ "get": {
1008
+ "tags": [
1009
+ "Enroll Status API"
1010
+ ],
1011
+ "summary": "enrollStatusUsingGET",
1012
+ "description": "This API is used to get certificate enrollment status.",
1013
+ "operationId": "enrollStatusUsingGET",
1014
+ "parameters": [
1015
+ {
1016
+ "name": "X-API-Key",
1017
+ "in": "header",
1018
+ "description": "",
1019
+ "style": "simple",
1020
+ "schema": {
1021
+ "type": "string"
1022
+ }
1023
+ },
1024
+ {
1025
+ "name": "profile_id",
1026
+ "in": "query",
1027
+ "description": "profile_id",
1028
+ "style": "form",
1029
+ "explode": true,
1030
+ "schema": {
1031
+ "type": "string"
1032
+ }
1033
+ },
1034
+ {
1035
+ "name": "seatId",
1036
+ "in": "path",
1037
+ "description": "seatId",
1038
+ "required": true,
1039
+ "style": "simple",
1040
+ "schema": {
1041
+ "type": "string"
1042
+ }
1043
+ }
1044
+ ],
1045
+ "responses": {
1046
+ "200": {
1047
+ "description": "Certificate enrollment status result",
1048
+ "headers": {},
1049
+ "content": {
1050
+ "application/json": {
1051
+ "schema": {
1052
+ "type": "array",
1053
+ "items": {
1054
+ "$ref": "#/components/schemas/GetEnrollStatusResponse"
1055
+ },
1056
+ "description": ""
1057
+ }
1058
+ }
1059
+ }
1060
+ },
1061
+ "400": {
1062
+ "description": "Bad Request",
1063
+ "headers": {},
1064
+ "content": {
1065
+ "application/json": {
1066
+ "schema": {
1067
+ "$ref": "#/components/schemas/ErrorResponse"
1068
+ }
1069
+ }
1070
+ }
1071
+ },
1072
+ "401": {
1073
+ "description": "Unauthorized",
1074
+ "headers": {},
1075
+ "content": {}
1076
+ },
1077
+ "403": {
1078
+ "description": "Forbidden",
1079
+ "headers": {},
1080
+ "content": {}
1081
+ },
1082
+ "404": {
1083
+ "description": "Not Found",
1084
+ "headers": {},
1085
+ "content": {
1086
+ "application/json": {
1087
+ "schema": {
1088
+ "$ref": "#/components/schemas/ErrorResponse"
1089
+ }
1090
+ }
1091
+ }
1092
+ },
1093
+ "500": {
1094
+ "description": "Internal Server Error",
1095
+ "headers": {},
1096
+ "content": {
1097
+ "application/json": {
1098
+ "schema": {
1099
+ "$ref": "#/components/schemas/ErrorResponse"
1100
+ }
1101
+ }
1102
+ }
1103
+ }
1104
+ },
1105
+ "deprecated": false
1106
+ }
1107
+ },
1108
+ "/api/v1/hello": {
1109
+ "get": {
1110
+ "tags": [
1111
+ "Hello API"
1112
+ ],
1113
+ "summary": "helloUsingGET",
1114
+ "description": "Hello API",
1115
+ "operationId": "helloUsingGET",
1116
+ "parameters": [
1117
+ {
1118
+ "name": "X-API-Key",
1119
+ "in": "header",
1120
+ "description": "",
1121
+ "style": "simple",
1122
+ "schema": {
1123
+ "type": "string"
1124
+ }
1125
+ }
1126
+ ],
1127
+ "responses": {
1128
+ "200": {
1129
+ "description": "OK",
1130
+ "headers": {},
1131
+ "content": {
1132
+ "*/*": {
1133
+ "schema": {}
1134
+ }
1135
+ }
1136
+ },
1137
+ "401": {
1138
+ "description": "Unauthorized",
1139
+ "headers": {},
1140
+ "content": {}
1141
+ },
1142
+ "403": {
1143
+ "description": "Forbidden",
1144
+ "headers": {},
1145
+ "content": {}
1146
+ },
1147
+ "404": {
1148
+ "description": "Not Found",
1149
+ "headers": {},
1150
+ "content": {}
1151
+ }
1152
+ },
1153
+ "deprecated": false
1154
+ }
1155
+ },
1156
+ "/api/v1/profile/activate": {
1157
+ "put": {
1158
+ "tags": [
1159
+ "PROFILE API"
1160
+ ],
1161
+ "summary": "activateProfileUsingPUT",
1162
+ "description": "This API is used to suspend a profile",
1163
+ "operationId": "activateProfileUsingPUT",
1164
+ "parameters": [
1165
+ {
1166
+ "name": "X-API-Key",
1167
+ "in": "header",
1168
+ "description": "",
1169
+ "style": "simple",
1170
+ "schema": {
1171
+ "type": "string"
1172
+ }
1173
+ }
1174
+ ],
1175
+ "requestBody": {
1176
+ "description": "profileCreationRequest",
1177
+ "content": {
1178
+ "application/json": {
1179
+ "schema": {
1180
+ "allOf": [
1181
+ {
1182
+ "$ref": "#/components/schemas/ProfileCreationRequest"
1183
+ },
1184
+ {
1185
+ "description": "profileCreationRequest"
1186
+ }
1187
+ ]
1188
+ }
1189
+ }
1190
+ },
1191
+ "required": true
1192
+ },
1193
+ "responses": {
1194
+ "200": {
1195
+ "description": "OK",
1196
+ "headers": {},
1197
+ "content": {
1198
+ "*/*": {
1199
+ "schema": {}
1200
+ }
1201
+ }
1202
+ },
1203
+ "201": {
1204
+ "description": "Created",
1205
+ "headers": {},
1206
+ "content": {}
1207
+ },
1208
+ "401": {
1209
+ "description": "Unauthorized",
1210
+ "headers": {},
1211
+ "content": {}
1212
+ },
1213
+ "403": {
1214
+ "description": "Forbidden",
1215
+ "headers": {},
1216
+ "content": {}
1217
+ },
1218
+ "404": {
1219
+ "description": "Not Found",
1220
+ "headers": {},
1221
+ "content": {}
1222
+ }
1223
+ },
1224
+ "deprecated": false
1225
+ }
1226
+ },
1227
+ "/api/v1/profile/create": {
1228
+ "post": {
1229
+ "tags": [
1230
+ "PROFILE API"
1231
+ ],
1232
+ "summary": "createProfileUsingPOST",
1233
+ "description": "This API is used to create a profile",
1234
+ "operationId": "createProfileUsingPOST",
1235
+ "parameters": [
1236
+ {
1237
+ "name": "X-API-Key",
1238
+ "in": "header",
1239
+ "description": "",
1240
+ "style": "simple",
1241
+ "schema": {
1242
+ "type": "string"
1243
+ }
1244
+ }
1245
+ ],
1246
+ "requestBody": {
1247
+ "description": "profileCreationRequest",
1248
+ "content": {
1249
+ "application/json": {
1250
+ "schema": {
1251
+ "allOf": [
1252
+ {
1253
+ "$ref": "#/components/schemas/ProfileCreationRequest"
1254
+ },
1255
+ {
1256
+ "description": "profileCreationRequest"
1257
+ }
1258
+ ]
1259
+ }
1260
+ }
1261
+ },
1262
+ "required": true
1263
+ },
1264
+ "responses": {
1265
+ "200": {
1266
+ "description": "OK",
1267
+ "headers": {},
1268
+ "content": {
1269
+ "application/json": {
1270
+ "schema": {
1271
+ "type": "object"
1272
+ }
1273
+ }
1274
+ }
1275
+ },
1276
+ "201": {
1277
+ "description": "Created",
1278
+ "headers": {},
1279
+ "content": {}
1280
+ },
1281
+ "401": {
1282
+ "description": "Unauthorized",
1283
+ "headers": {},
1284
+ "content": {}
1285
+ },
1286
+ "403": {
1287
+ "description": "Forbidden",
1288
+ "headers": {},
1289
+ "content": {}
1290
+ },
1291
+ "404": {
1292
+ "description": "Not Found",
1293
+ "headers": {},
1294
+ "content": {}
1295
+ }
1296
+ },
1297
+ "deprecated": false
1298
+ }
1299
+ },
1300
+ "/api/v1/profile/delete": {
1301
+ "put": {
1302
+ "tags": [
1303
+ "PROFILE API"
1304
+ ],
1305
+ "summary": "deleteProfileUsingPUT",
1306
+ "description": "This API is used to delete a profile",
1307
+ "operationId": "deleteProfileUsingPUT",
1308
+ "parameters": [
1309
+ {
1310
+ "name": "X-API-Key",
1311
+ "in": "header",
1312
+ "description": "",
1313
+ "style": "simple",
1314
+ "schema": {
1315
+ "type": "string"
1316
+ }
1317
+ }
1318
+ ],
1319
+ "requestBody": {
1320
+ "description": "profileCreationRequest",
1321
+ "content": {
1322
+ "application/json": {
1323
+ "schema": {
1324
+ "allOf": [
1325
+ {
1326
+ "$ref": "#/components/schemas/ProfileCreationRequest"
1327
+ },
1328
+ {
1329
+ "description": "profileCreationRequest"
1330
+ }
1331
+ ]
1332
+ }
1333
+ }
1334
+ },
1335
+ "required": true
1336
+ },
1337
+ "responses": {
1338
+ "200": {
1339
+ "description": "OK",
1340
+ "headers": {},
1341
+ "content": {
1342
+ "*/*": {
1343
+ "schema": {}
1344
+ }
1345
+ }
1346
+ },
1347
+ "201": {
1348
+ "description": "Created",
1349
+ "headers": {},
1350
+ "content": {}
1351
+ },
1352
+ "401": {
1353
+ "description": "Unauthorized",
1354
+ "headers": {},
1355
+ "content": {}
1356
+ },
1357
+ "403": {
1358
+ "description": "Forbidden",
1359
+ "headers": {},
1360
+ "content": {}
1361
+ },
1362
+ "404": {
1363
+ "description": "Not Found",
1364
+ "headers": {},
1365
+ "content": {}
1366
+ }
1367
+ },
1368
+ "deprecated": false
1369
+ }
1370
+ },
1371
+ "/api/v1/profile/edit": {
1372
+ "put": {
1373
+ "tags": [
1374
+ "PROFILE API"
1375
+ ],
1376
+ "summary": "updateProfileUsingPUT",
1377
+ "description": "This API is used to create a profile",
1378
+ "operationId": "updateProfileUsingPUT",
1379
+ "parameters": [
1380
+ {
1381
+ "name": "X-API-Key",
1382
+ "in": "header",
1383
+ "description": "",
1384
+ "style": "simple",
1385
+ "schema": {
1386
+ "type": "string"
1387
+ }
1388
+ }
1389
+ ],
1390
+ "requestBody": {
1391
+ "description": "profileCreationRequest",
1392
+ "content": {
1393
+ "application/json": {
1394
+ "schema": {
1395
+ "allOf": [
1396
+ {
1397
+ "$ref": "#/components/schemas/ProfileCreationRequest"
1398
+ },
1399
+ {
1400
+ "description": "profileCreationRequest"
1401
+ }
1402
+ ]
1403
+ }
1404
+ }
1405
+ },
1406
+ "required": true
1407
+ },
1408
+ "responses": {
1409
+ "200": {
1410
+ "description": "OK",
1411
+ "headers": {},
1412
+ "content": {
1413
+ "*/*": {
1414
+ "schema": {}
1415
+ }
1416
+ }
1417
+ },
1418
+ "201": {
1419
+ "description": "Created",
1420
+ "headers": {},
1421
+ "content": {}
1422
+ },
1423
+ "401": {
1424
+ "description": "Unauthorized",
1425
+ "headers": {},
1426
+ "content": {}
1427
+ },
1428
+ "403": {
1429
+ "description": "Forbidden",
1430
+ "headers": {},
1431
+ "content": {}
1432
+ },
1433
+ "404": {
1434
+ "description": "Not Found",
1435
+ "headers": {},
1436
+ "content": {}
1437
+ }
1438
+ },
1439
+ "deprecated": false
1440
+ }
1441
+ },
1442
+ "/api/v1/profile/suspend": {
1443
+ "put": {
1444
+ "tags": [
1445
+ "PROFILE API"
1446
+ ],
1447
+ "summary": "suspendProfileUsingPUT",
1448
+ "description": "This API is used to suspend a profile",
1449
+ "operationId": "suspendProfileUsingPUT",
1450
+ "parameters": [
1451
+ {
1452
+ "name": "X-API-Key",
1453
+ "in": "header",
1454
+ "description": "",
1455
+ "style": "simple",
1456
+ "schema": {
1457
+ "type": "string"
1458
+ }
1459
+ }
1460
+ ],
1461
+ "requestBody": {
1462
+ "description": "profileCreationRequest",
1463
+ "content": {
1464
+ "application/json": {
1465
+ "schema": {
1466
+ "allOf": [
1467
+ {
1468
+ "$ref": "#/components/schemas/ProfileCreationRequest"
1469
+ },
1470
+ {
1471
+ "description": "profileCreationRequest"
1472
+ }
1473
+ ]
1474
+ }
1475
+ }
1476
+ },
1477
+ "required": true
1478
+ },
1479
+ "responses": {
1480
+ "200": {
1481
+ "description": "OK",
1482
+ "headers": {},
1483
+ "content": {
1484
+ "*/*": {
1485
+ "schema": {}
1486
+ }
1487
+ }
1488
+ },
1489
+ "201": {
1490
+ "description": "Created",
1491
+ "headers": {},
1492
+ "content": {}
1493
+ },
1494
+ "401": {
1495
+ "description": "Unauthorized",
1496
+ "headers": {},
1497
+ "content": {}
1498
+ },
1499
+ "403": {
1500
+ "description": "Forbidden",
1501
+ "headers": {},
1502
+ "content": {}
1503
+ },
1504
+ "404": {
1505
+ "description": "Not Found",
1506
+ "headers": {},
1507
+ "content": {}
1508
+ }
1509
+ },
1510
+ "deprecated": false
1511
+ }
1512
+ },
1513
+ "/api/v1/profile/test": {
1514
+ "post": {
1515
+ "tags": [
1516
+ "PROFILE API"
1517
+ ],
1518
+ "summary": "testCreateUsingPOST",
1519
+ "description": "This API is used to create a profile",
1520
+ "operationId": "testCreateUsingPOST",
1521
+ "parameters": [
1522
+ {
1523
+ "name": "X-API-Key",
1524
+ "in": "header",
1525
+ "description": "",
1526
+ "style": "simple",
1527
+ "schema": {
1528
+ "type": "string"
1529
+ }
1530
+ },
1531
+ {
1532
+ "name": "Content-Type",
1533
+ "in": "header",
1534
+ "description": "",
1535
+ "required": true,
1536
+ "style": "simple",
1537
+ "schema": {
1538
+ "enum": [
1539
+ "application/json"
1540
+ ],
1541
+ "type": "string"
1542
+ }
1543
+ }
1544
+ ],
1545
+ "responses": {
1546
+ "200": {
1547
+ "description": "OK",
1548
+ "headers": {},
1549
+ "content": {
1550
+ "application/json": {
1551
+ "schema": {
1552
+ "type": "object"
1553
+ }
1554
+ }
1555
+ }
1556
+ },
1557
+ "201": {
1558
+ "description": "Created",
1559
+ "headers": {},
1560
+ "content": {}
1561
+ },
1562
+ "401": {
1563
+ "description": "Unauthorized",
1564
+ "headers": {},
1565
+ "content": {}
1566
+ },
1567
+ "403": {
1568
+ "description": "Forbidden",
1569
+ "headers": {},
1570
+ "content": {}
1571
+ },
1572
+ "404": {
1573
+ "description": "Not Found",
1574
+ "headers": {},
1575
+ "content": {}
1576
+ }
1577
+ },
1578
+ "deprecated": false
1579
+ }
1580
+ },
1581
+ "/api/v1/searchcert": {
1582
+ "post": {
1583
+ "tags": [
1584
+ "Search Certificate API"
1585
+ ],
1586
+ "summary": "searchCertUsingPOST",
1587
+ "description": "This API is used to search for certificates.",
1588
+ "operationId": "searchCertUsingPOST",
1589
+ "parameters": [
1590
+ {
1591
+ "name": "X-API-Key",
1592
+ "in": "header",
1593
+ "description": "",
1594
+ "style": "simple",
1595
+ "schema": {
1596
+ "type": "string"
1597
+ }
1598
+ }
1599
+ ],
1600
+ "requestBody": {
1601
+ "description": "searchReq",
1602
+ "content": {
1603
+ "application/json": {
1604
+ "schema": {
1605
+ "allOf": [
1606
+ {
1607
+ "$ref": "#/components/schemas/SearchCertificateRequest"
1608
+ },
1609
+ {
1610
+ "description": "searchReq"
1611
+ }
1612
+ ]
1613
+ }
1614
+ }
1615
+ },
1616
+ "required": true
1617
+ },
1618
+ "responses": {
1619
+ "200": {
1620
+ "description": "Certificate search result",
1621
+ "headers": {},
1622
+ "content": {
1623
+ "application/json": {
1624
+ "schema": {
1625
+ "$ref": "#/components/schemas/SearchCertificateResponse"
1626
+ }
1627
+ }
1628
+ }
1629
+ },
1630
+ "201": {
1631
+ "description": "Created",
1632
+ "headers": {},
1633
+ "content": {}
1634
+ },
1635
+ "400": {
1636
+ "description": "Bad Request",
1637
+ "headers": {},
1638
+ "content": {
1639
+ "application/json": {
1640
+ "schema": {
1641
+ "$ref": "#/components/schemas/ErrorResponse"
1642
+ }
1643
+ }
1644
+ }
1645
+ },
1646
+ "401": {
1647
+ "description": "Unauthorized",
1648
+ "headers": {},
1649
+ "content": {}
1650
+ },
1651
+ "403": {
1652
+ "description": "Forbidden",
1653
+ "headers": {},
1654
+ "content": {}
1655
+ },
1656
+ "404": {
1657
+ "description": "Not Found",
1658
+ "headers": {},
1659
+ "content": {
1660
+ "application/json": {
1661
+ "schema": {
1662
+ "$ref": "#/components/schemas/ErrorResponse"
1663
+ }
1664
+ }
1665
+ }
1666
+ },
1667
+ "500": {
1668
+ "description": "Internal Server Error",
1669
+ "headers": {},
1670
+ "content": {
1671
+ "application/json": {
1672
+ "schema": {
1673
+ "$ref": "#/components/schemas/ErrorResponse"
1674
+ }
1675
+ }
1676
+ }
1677
+ }
1678
+ },
1679
+ "deprecated": false
1680
+ }
1681
+ },
1682
+ "/api/v1/seat": {
1683
+ "post": {
1684
+ "tags": [
1685
+ "Seat Management API"
1686
+ ],
1687
+ "summary": "createSeatUsingPOST",
1688
+ "description": "This API is used to create a seat. This seat can be used for a user, device, server or organization seat pool.",
1689
+ "operationId": "createSeatUsingPOST",
1690
+ "parameters": [
1691
+ {
1692
+ "name": "X-API-Key",
1693
+ "in": "header",
1694
+ "description": "",
1695
+ "style": "simple",
1696
+ "schema": {
1697
+ "type": "string"
1698
+ }
1699
+ }
1700
+ ],
1701
+ "requestBody": {
1702
+ "description": "createSeatRequest",
1703
+ "content": {
1704
+ "application/json": {
1705
+ "schema": {
1706
+ "allOf": [
1707
+ {
1708
+ "$ref": "#/components/schemas/CreateSeatRequest"
1709
+ },
1710
+ {
1711
+ "description": "createSeatRequest"
1712
+ }
1713
+ ]
1714
+ }
1715
+ }
1716
+ },
1717
+ "required": true
1718
+ },
1719
+ "responses": {
1720
+ "201": {
1721
+ "description": "Created",
1722
+ "headers": {},
1723
+ "content": {
1724
+ "application/json": {
1725
+ "schema": {
1726
+ "type": "object"
1727
+ }
1728
+ }
1729
+ }
1730
+ },
1731
+ "401": {
1732
+ "description": "Unauthorized",
1733
+ "headers": {},
1734
+ "content": {}
1735
+ },
1736
+ "403": {
1737
+ "description": "Forbidden",
1738
+ "headers": {},
1739
+ "content": {}
1740
+ },
1741
+ "404": {
1742
+ "description": "Not Found",
1743
+ "headers": {},
1744
+ "content": {}
1745
+ }
1746
+ },
1747
+ "deprecated": false
1748
+ }
1749
+ },
1750
+ "/api/v1/seat/{seatId}": {
1751
+ "get": {
1752
+ "tags": [
1753
+ "Seat Management API"
1754
+ ],
1755
+ "summary": "getSeatUsingGET",
1756
+ "description": "This API is used to get information regarding a seat.",
1757
+ "operationId": "getSeatUsingGET",
1758
+ "parameters": [
1759
+ {
1760
+ "name": "X-API-Key",
1761
+ "in": "header",
1762
+ "description": "",
1763
+ "style": "simple",
1764
+ "schema": {
1765
+ "type": "string"
1766
+ }
1767
+ },
1768
+ {
1769
+ "name": "seatId",
1770
+ "in": "path",
1771
+ "description": "seatId",
1772
+ "required": true,
1773
+ "style": "simple",
1774
+ "schema": {
1775
+ "type": "string"
1776
+ }
1777
+ }
1778
+ ],
1779
+ "responses": {
1780
+ "200": {
1781
+ "description": "OK",
1782
+ "headers": {},
1783
+ "content": {
1784
+ "application/json": {
1785
+ "schema": {
1786
+ "type": "object"
1787
+ }
1788
+ }
1789
+ }
1790
+ },
1791
+ "401": {
1792
+ "description": "Unauthorized",
1793
+ "headers": {},
1794
+ "content": {}
1795
+ },
1796
+ "403": {
1797
+ "description": "Forbidden",
1798
+ "headers": {},
1799
+ "content": {}
1800
+ },
1801
+ "404": {
1802
+ "description": "Not Found",
1803
+ "headers": {},
1804
+ "content": {}
1805
+ }
1806
+ },
1807
+ "deprecated": false
1808
+ },
1809
+ "put": {
1810
+ "tags": [
1811
+ "Seat Management API"
1812
+ ],
1813
+ "summary": "updateSeatUsingPUT",
1814
+ "description": "This API is used to change the seat details.",
1815
+ "operationId": "updateSeatUsingPUT",
1816
+ "parameters": [
1817
+ {
1818
+ "name": "X-API-Key",
1819
+ "in": "header",
1820
+ "description": "",
1821
+ "style": "simple",
1822
+ "schema": {
1823
+ "type": "string"
1824
+ }
1825
+ },
1826
+ {
1827
+ "name": "seatId",
1828
+ "in": "path",
1829
+ "description": "seatId",
1830
+ "required": true,
1831
+ "style": "simple",
1832
+ "schema": {
1833
+ "type": "string"
1834
+ }
1835
+ }
1836
+ ],
1837
+ "requestBody": {
1838
+ "description": "updateSeatRequest",
1839
+ "content": {
1840
+ "application/json": {
1841
+ "schema": {
1842
+ "allOf": [
1843
+ {
1844
+ "$ref": "#/components/schemas/UpdateSeatRequest"
1845
+ },
1846
+ {
1847
+ "description": "updateSeatRequest"
1848
+ }
1849
+ ]
1850
+ }
1851
+ }
1852
+ },
1853
+ "required": true
1854
+ },
1855
+ "responses": {
1856
+ "200": {
1857
+ "description": "OK",
1858
+ "headers": {},
1859
+ "content": {
1860
+ "application/json": {
1861
+ "schema": {
1862
+ "type": "object"
1863
+ }
1864
+ }
1865
+ }
1866
+ },
1867
+ "201": {
1868
+ "description": "Created",
1869
+ "headers": {},
1870
+ "content": {}
1871
+ },
1872
+ "401": {
1873
+ "description": "Unauthorized",
1874
+ "headers": {},
1875
+ "content": {}
1876
+ },
1877
+ "403": {
1878
+ "description": "Forbidden",
1879
+ "headers": {},
1880
+ "content": {}
1881
+ },
1882
+ "404": {
1883
+ "description": "Not Found",
1884
+ "headers": {},
1885
+ "content": {}
1886
+ }
1887
+ },
1888
+ "deprecated": false
1889
+ },
1890
+ "delete": {
1891
+ "tags": [
1892
+ "Seat Management API"
1893
+ ],
1894
+ "summary": "deleteSeatUsingDELETE",
1895
+ "description": "This API is used to delete a seat. Deleting a seat will revoke all the certificates associated to the specified seat.",
1896
+ "operationId": "deleteSeatUsingDELETE",
1897
+ "parameters": [
1898
+ {
1899
+ "name": "X-API-Key",
1900
+ "in": "header",
1901
+ "description": "",
1902
+ "style": "simple",
1903
+ "schema": {
1904
+ "type": "string"
1905
+ }
1906
+ },
1907
+ {
1908
+ "name": "seatId",
1909
+ "in": "path",
1910
+ "description": "seatId",
1911
+ "required": true,
1912
+ "style": "simple",
1913
+ "schema": {
1914
+ "type": "string"
1915
+ }
1916
+ }
1917
+ ],
1918
+ "responses": {
1919
+ "200": {
1920
+ "description": "OK",
1921
+ "headers": {},
1922
+ "content": {
1923
+ "application/json": {
1924
+ "schema": {
1925
+ "type": "object"
1926
+ }
1927
+ }
1928
+ }
1929
+ },
1930
+ "204": {
1931
+ "description": "No Content",
1932
+ "headers": {},
1933
+ "content": {}
1934
+ },
1935
+ "401": {
1936
+ "description": "Unauthorized",
1937
+ "headers": {},
1938
+ "content": {}
1939
+ },
1940
+ "403": {
1941
+ "description": "Forbidden",
1942
+ "headers": {},
1943
+ "content": {}
1944
+ }
1945
+ },
1946
+ "deprecated": false
1947
+ }
1948
+ },
1949
+ "/api/v1/enrollment": {
1950
+ "post": {
1951
+ "tags": [
1952
+ "User Management API"
1953
+ ],
1954
+ "summary": "createPasscodeUsingPOST",
1955
+ "description": "This API is used to enroll user for profile.",
1956
+ "operationId": "createPasscodeUsingPOST",
1957
+ "parameters": [
1958
+ {
1959
+ "name": "X-API-Key",
1960
+ "in": "header",
1961
+ "description": "",
1962
+ "style": "simple",
1963
+ "schema": {
1964
+ "type": "string"
1965
+ }
1966
+ }
1967
+ ],
1968
+ "requestBody": {
1969
+ "description": "createPasscodeRequest",
1970
+ "content": {
1971
+ "application/json": {
1972
+ "schema": {
1973
+ "allOf": [
1974
+ {
1975
+ "$ref": "#/components/schemas/CreatePasscodeRequest"
1976
+ },
1977
+ {
1978
+ "description": "createPasscodeRequest"
1979
+ }
1980
+ ]
1981
+ }
1982
+ }
1983
+ },
1984
+ "required": true
1985
+ },
1986
+ "responses": {
1987
+ "201": {
1988
+ "description": "Created",
1989
+ "headers": {},
1990
+ "content": {
1991
+ "application/json": {
1992
+ "schema": {
1993
+ "type": "object"
1994
+ }
1995
+ }
1996
+ }
1997
+ },
1998
+ "401": {
1999
+ "description": "Unauthorized",
2000
+ "headers": {},
2001
+ "content": {}
2002
+ },
2003
+ "403": {
2004
+ "description": "Forbidden",
2005
+ "headers": {},
2006
+ "content": {}
2007
+ },
2008
+ "404": {
2009
+ "description": "Not Found",
2010
+ "headers": {},
2011
+ "content": {}
2012
+ }
2013
+ },
2014
+ "deprecated": false
2015
+ }
2016
+ },
2017
+ "/api/v1/enrollment/{enrollCode}": {
2018
+ "get": {
2019
+ "tags": [
2020
+ "User Management API"
2021
+ ],
2022
+ "summary": "getEnrollmentUsingGET",
2023
+ "description": "This API is used to get details of an existing enrollment.",
2024
+ "operationId": "getEnrollmentUsingGET",
2025
+ "parameters": [
2026
+ {
2027
+ "name": "X-API-Key",
2028
+ "in": "header",
2029
+ "description": "",
2030
+ "style": "simple",
2031
+ "schema": {
2032
+ "type": "string"
2033
+ }
2034
+ },
2035
+ {
2036
+ "name": "enrollCode",
2037
+ "in": "path",
2038
+ "description": "enrollCode",
2039
+ "required": true,
2040
+ "style": "simple",
2041
+ "schema": {
2042
+ "type": "string"
2043
+ }
2044
+ },
2045
+ {
2046
+ "name": "seat_id",
2047
+ "in": "query",
2048
+ "description": "seat_id",
2049
+ "required": true,
2050
+ "style": "form",
2051
+ "explode": true,
2052
+ "schema": {
2053
+ "type": "string"
2054
+ }
2055
+ }
2056
+ ],
2057
+ "responses": {
2058
+ "200": {
2059
+ "description": "OK",
2060
+ "headers": {},
2061
+ "content": {
2062
+ "application/json": {
2063
+ "schema": {
2064
+ "type": "object"
2065
+ }
2066
+ }
2067
+ }
2068
+ },
2069
+ "401": {
2070
+ "description": "Unauthorized",
2071
+ "headers": {},
2072
+ "content": {}
2073
+ },
2074
+ "403": {
2075
+ "description": "Forbidden",
2076
+ "headers": {},
2077
+ "content": {}
2078
+ },
2079
+ "404": {
2080
+ "description": "Not Found",
2081
+ "headers": {},
2082
+ "content": {}
2083
+ }
2084
+ },
2085
+ "deprecated": false
2086
+ },
2087
+ "put": {
2088
+ "tags": [
2089
+ "User Management API"
2090
+ ],
2091
+ "summary": "resetPasscodeUsingPUT",
2092
+ "description": "This API is used to reset enrollment code.",
2093
+ "operationId": "resetPasscodeUsingPUT",
2094
+ "parameters": [
2095
+ {
2096
+ "name": "X-API-Key",
2097
+ "in": "header",
2098
+ "description": "",
2099
+ "style": "simple",
2100
+ "schema": {
2101
+ "type": "string"
2102
+ }
2103
+ },
2104
+ {
2105
+ "name": "enrollCode",
2106
+ "in": "path",
2107
+ "description": "enrollCode",
2108
+ "required": true,
2109
+ "style": "simple",
2110
+ "schema": {
2111
+ "type": "string"
2112
+ }
2113
+ }
2114
+ ],
2115
+ "requestBody": {
2116
+ "description": "resetPasscodeRequest",
2117
+ "content": {
2118
+ "application/json": {
2119
+ "schema": {
2120
+ "allOf": [
2121
+ {
2122
+ "$ref": "#/components/schemas/ResetPasscodeRequest"
2123
+ },
2124
+ {
2125
+ "description": "resetPasscodeRequest"
2126
+ }
2127
+ ]
2128
+ }
2129
+ }
2130
+ },
2131
+ "required": true
2132
+ },
2133
+ "responses": {
2134
+ "200": {
2135
+ "description": "OK",
2136
+ "headers": {},
2137
+ "content": {
2138
+ "application/json": {
2139
+ "schema": {
2140
+ "type": "object"
2141
+ }
2142
+ }
2143
+ }
2144
+ },
2145
+ "201": {
2146
+ "description": "Created",
2147
+ "headers": {},
2148
+ "content": {}
2149
+ },
2150
+ "401": {
2151
+ "description": "Unauthorized",
2152
+ "headers": {},
2153
+ "content": {}
2154
+ },
2155
+ "403": {
2156
+ "description": "Forbidden",
2157
+ "headers": {},
2158
+ "content": {}
2159
+ },
2160
+ "404": {
2161
+ "description": "Not Found",
2162
+ "headers": {},
2163
+ "content": {}
2164
+ }
2165
+ },
2166
+ "deprecated": false
2167
+ },
2168
+ "delete": {
2169
+ "tags": [
2170
+ "User Management API"
2171
+ ],
2172
+ "summary": "deleteEnrollmentUsingDELETE",
2173
+ "description": "This API can delete an enrollment for given enrollment id",
2174
+ "operationId": "deleteEnrollmentUsingDELETE",
2175
+ "parameters": [
2176
+ {
2177
+ "name": "X-API-Key",
2178
+ "in": "header",
2179
+ "description": "",
2180
+ "style": "simple",
2181
+ "schema": {
2182
+ "type": "string"
2183
+ }
2184
+ },
2185
+ {
2186
+ "name": "enrollCode",
2187
+ "in": "path",
2188
+ "description": "enrollCode",
2189
+ "required": true,
2190
+ "style": "simple",
2191
+ "schema": {
2192
+ "type": "string"
2193
+ }
2194
+ }
2195
+ ],
2196
+ "responses": {
2197
+ "200": {
2198
+ "description": "OK",
2199
+ "headers": {},
2200
+ "content": {
2201
+ "application/json": {
2202
+ "schema": {
2203
+ "type": "object"
2204
+ }
2205
+ }
2206
+ }
2207
+ },
2208
+ "204": {
2209
+ "description": "No Content",
2210
+ "headers": {},
2211
+ "content": {}
2212
+ },
2213
+ "401": {
2214
+ "description": "Unauthorized",
2215
+ "headers": {},
2216
+ "content": {}
2217
+ },
2218
+ "403": {
2219
+ "description": "Forbidden",
2220
+ "headers": {},
2221
+ "content": {}
2222
+ }
2223
+ },
2224
+ "deprecated": false
2225
+ }
2226
+ }
2227
+ },
2228
+ "components": {
2229
+ "schemas": {
2230
+ "Account": {
2231
+ "title": "Account",
2232
+ "type": "object",
2233
+ "properties": {
2234
+ "id": {
2235
+ "type": "integer",
2236
+ "format": "int64"
2237
+ }
2238
+ }
2239
+ },
2240
+ "ApiError": {
2241
+ "title": "ApiError",
2242
+ "type": "object",
2243
+ "properties": {
2244
+ "code": {
2245
+ "type": "string"
2246
+ },
2247
+ "field": {
2248
+ "type": "string"
2249
+ },
2250
+ "message": {
2251
+ "type": "string"
2252
+ }
2253
+ }
2254
+ },
2255
+ "Attribute": {
2256
+ "title": "Attribute",
2257
+ "type": "object",
2258
+ "properties": {
2259
+ "id": {
2260
+ "type": "string"
2261
+ },
2262
+ "mandatory": {
2263
+ "type": "boolean"
2264
+ },
2265
+ "type": {
2266
+ "type": "string"
2267
+ },
2268
+ "value": {
2269
+ "type": "string"
2270
+ }
2271
+ }
2272
+ },
2273
+ "AttributeSource": {
2274
+ "title": "AttributeSource",
2275
+ "type": "object",
2276
+ "properties": {
2277
+ "mandatory": {
2278
+ "type": "boolean"
2279
+ },
2280
+ "value": {
2281
+ "type": "object"
2282
+ }
2283
+ }
2284
+ },
2285
+ "AuthAttribute": {
2286
+ "title": "AuthAttribute",
2287
+ "type": "object",
2288
+ "properties": {
2289
+ "display_name": {
2290
+ "type": "string"
2291
+ },
2292
+ "id": {
2293
+ "type": "string"
2294
+ },
2295
+ "mandatory": {
2296
+ "type": "boolean"
2297
+ },
2298
+ "type": {
2299
+ "type": "string"
2300
+ },
2301
+ "value": {
2302
+ "type": "string"
2303
+ }
2304
+ }
2305
+ },
2306
+ "Authentication": {
2307
+ "title": "Authentication",
2308
+ "type": "object",
2309
+ "properties": {
2310
+ "approval": {
2311
+ "type": "string"
2312
+ },
2313
+ "attributes": {
2314
+ "type": "array",
2315
+ "items": {
2316
+ "$ref": "#/components/schemas/AuthAttribute"
2317
+ },
2318
+ "description": ""
2319
+ },
2320
+ "method": {
2321
+ "type": "string"
2322
+ },
2323
+ "method_id": {
2324
+ "type": "string"
2325
+ }
2326
+ }
2327
+ },
2328
+ "CertificateAttributes": {
2329
+ "title": "CertificateAttributes",
2330
+ "type": "object",
2331
+ "properties": {
2332
+ "common_name": {
2333
+ "type": "string"
2334
+ },
2335
+ "content_type": {
2336
+ "type": "string"
2337
+ },
2338
+ "counter_signature": {
2339
+ "type": "string"
2340
+ },
2341
+ "country": {
2342
+ "type": "string"
2343
+ },
2344
+ "custom_attributes": {
2345
+ "type": "object",
2346
+ "additionalProperties": {
2347
+ "type": "string"
2348
+ }
2349
+ },
2350
+ "dn_qualifier": {
2351
+ "type": "string"
2352
+ },
2353
+ "domain_component": {
2354
+ "type": "array",
2355
+ "items": {
2356
+ "$ref": "#/components/schemas/Attribute"
2357
+ },
2358
+ "description": ""
2359
+ },
2360
+ "domain_name": {
2361
+ "type": "string"
2362
+ },
2363
+ "email": {
2364
+ "type": "string"
2365
+ },
2366
+ "given_name": {
2367
+ "type": "string"
2368
+ },
2369
+ "ip_address": {
2370
+ "type": "string"
2371
+ },
2372
+ "job_title": {
2373
+ "type": "string"
2374
+ },
2375
+ "locality": {
2376
+ "type": "string"
2377
+ },
2378
+ "message_digest": {
2379
+ "type": "string"
2380
+ },
2381
+ "organization_name": {
2382
+ "type": "string"
2383
+ },
2384
+ "organization_unit": {
2385
+ "type": "array",
2386
+ "items": {
2387
+ "$ref": "#/components/schemas/Attribute"
2388
+ },
2389
+ "description": ""
2390
+ },
2391
+ "postal_code": {
2392
+ "type": "string"
2393
+ },
2394
+ "pseudonym": {
2395
+ "type": "string"
2396
+ },
2397
+ "san": {
2398
+ "$ref": "#/components/schemas/SanAttributes"
2399
+ },
2400
+ "serial_number": {
2401
+ "type": "string"
2402
+ },
2403
+ "signing_time": {
2404
+ "type": "string"
2405
+ },
2406
+ "state": {
2407
+ "type": "string"
2408
+ },
2409
+ "street_address": {
2410
+ "type": "array",
2411
+ "items": {
2412
+ "$ref": "#/components/schemas/Attribute"
2413
+ },
2414
+ "description": ""
2415
+ },
2416
+ "surname": {
2417
+ "type": "string"
2418
+ },
2419
+ "unique_identifier": {
2420
+ "type": "string"
2421
+ },
2422
+ "unstructured_address": {
2423
+ "type": "string"
2424
+ },
2425
+ "unstructured_name": {
2426
+ "type": "string"
2427
+ },
2428
+ "user_id": {
2429
+ "type": "string"
2430
+ }
2431
+ }
2432
+ },
2433
+ "CertificateDetails": {
2434
+ "title": "CertificateDetails",
2435
+ "type": "object",
2436
+ "properties": {
2437
+ "extensions": {
2438
+ "$ref": "#/components/schemas/Extensions"
2439
+ },
2440
+ "issuer": {
2441
+ "$ref": "#/components/schemas/Issuer"
2442
+ },
2443
+ "subject": {
2444
+ "$ref": "#/components/schemas/Subject"
2445
+ },
2446
+ "validity": {
2447
+ "$ref": "#/components/schemas/Validity"
2448
+ }
2449
+ }
2450
+ },
2451
+ "CertificateInfo": {
2452
+ "title": "CertificateInfo",
2453
+ "type": "object",
2454
+ "properties": {
2455
+ "certificate": {
2456
+ "type": "string"
2457
+ },
2458
+ "root": {
2459
+ "type": "boolean"
2460
+ },
2461
+ "serial_number": {
2462
+ "type": "string"
2463
+ },
2464
+ "subject_dn": {
2465
+ "type": "string"
2466
+ }
2467
+ }
2468
+ },
2469
+ "CreateCertificateRequest": {
2470
+ "title": "CreateCertificateRequest",
2471
+ "type": "object",
2472
+ "properties": {
2473
+ "csr": {
2474
+ "type": "string"
2475
+ },
2476
+ "extensions": {
2477
+ "type": "object"
2478
+ },
2479
+ "include_ca_chain": {
2480
+ "type": "boolean"
2481
+ },
2482
+ "profile": {
2483
+ "$ref": "#/components/schemas/Profile"
2484
+ },
2485
+ "seat": {
2486
+ "$ref": "#/components/schemas/Seat"
2487
+ },
2488
+ "subject": {
2489
+ "type": "object"
2490
+ },
2491
+ "validity": {
2492
+ "$ref": "#/components/schemas/Validity"
2493
+ }
2494
+ }
2495
+ },
2496
+ "CreatePasscodeRequest": {
2497
+ "title": "CreatePasscodeRequest",
2498
+ "type": "object",
2499
+ "properties": {
2500
+ "attributes": {
2501
+ "$ref": "#/components/schemas/CertificateAttributes"
2502
+ },
2503
+ "profile": {
2504
+ "$ref": "#/components/schemas/Profile"
2505
+ },
2506
+ "seat": {
2507
+ "$ref": "#/components/schemas/Seat"
2508
+ }
2509
+ }
2510
+ },
2511
+ "CreateSeatRequest": {
2512
+ "title": "CreateSeatRequest",
2513
+ "type": "object",
2514
+ "properties": {
2515
+ "email": {
2516
+ "type": "string"
2517
+ },
2518
+ "phone": {
2519
+ "type": "string"
2520
+ },
2521
+ "seat_id": {
2522
+ "type": "string"
2523
+ },
2524
+ "seat_name": {
2525
+ "type": "string"
2526
+ }
2527
+ }
2528
+ },
2529
+ "CryptoProviders": {
2530
+ "title": "CryptoProviders",
2531
+ "type": "object",
2532
+ "properties": {
2533
+ "provider": {
2534
+ "type": "array",
2535
+ "items": {
2536
+ "type": "string"
2537
+ },
2538
+ "description": ""
2539
+ }
2540
+ }
2541
+ },
2542
+ "DeleteEnrollmentRequest": {
2543
+ "title": "DeleteEnrollmentRequest",
2544
+ "type": "object",
2545
+ "properties": {
2546
+ "seat": {
2547
+ "$ref": "#/components/schemas/Seat"
2548
+ }
2549
+ }
2550
+ },
2551
+ "Enrollment": {
2552
+ "title": "Enrollment",
2553
+ "type": "object",
2554
+ "properties": {
2555
+ "client_type": {
2556
+ "type": "string"
2557
+ },
2558
+ "client_type_id": {
2559
+ "type": "string"
2560
+ }
2561
+ }
2562
+ },
2563
+ "ErrorResponse": {
2564
+ "title": "ErrorResponse",
2565
+ "type": "object",
2566
+ "properties": {
2567
+ "errors": {
2568
+ "type": "array",
2569
+ "items": {
2570
+ "$ref": "#/components/schemas/ApiError"
2571
+ },
2572
+ "description": ""
2573
+ }
2574
+ }
2575
+ },
2576
+ "ExtendedAttribute": {
2577
+ "title": "ExtendedAttribute",
2578
+ "type": "object",
2579
+ "properties": {
2580
+ "id": {
2581
+ "type": "string"
2582
+ },
2583
+ "mandatory": {
2584
+ "type": "boolean"
2585
+ },
2586
+ "multiple": {
2587
+ "type": "boolean"
2588
+ },
2589
+ "sources": {
2590
+ "type": "array",
2591
+ "items": {
2592
+ "$ref": "#/components/schemas/AttributeSource"
2593
+ },
2594
+ "description": ""
2595
+ },
2596
+ "type": {
2597
+ "type": "string"
2598
+ },
2599
+ "value": {
2600
+ "type": "string"
2601
+ }
2602
+ }
2603
+ },
2604
+ "ExtendedKeyUsageListType": {
2605
+ "title": "ExtendedKeyUsageListType",
2606
+ "type": "object",
2607
+ "properties": {
2608
+ "critical": {
2609
+ "type": "boolean"
2610
+ },
2611
+ "extended_key_usages": {
2612
+ "type": "array",
2613
+ "items": {
2614
+ "type": "string"
2615
+ },
2616
+ "description": ""
2617
+ }
2618
+ }
2619
+ },
2620
+ "Extensions": {
2621
+ "title": "Extensions",
2622
+ "type": "object",
2623
+ "properties": {
2624
+ "san": {
2625
+ "$ref": "#/components/schemas/San"
2626
+ }
2627
+ }
2628
+ },
2629
+ "GetCertificateResponse": {
2630
+ "title": "GetCertificateResponse",
2631
+ "type": "object",
2632
+ "properties": {
2633
+ "account": {
2634
+ "$ref": "#/components/schemas/Account"
2635
+ },
2636
+ "certificate": {
2637
+ "type": "string"
2638
+ },
2639
+ "common_name": {
2640
+ "type": "string"
2641
+ },
2642
+ "enrollment_notes": {
2643
+ "type": "string"
2644
+ },
2645
+ "is_key_escrowed": {
2646
+ "type": "boolean"
2647
+ },
2648
+ "password": {
2649
+ "type": "string"
2650
+ },
2651
+ "profile": {
2652
+ "$ref": "#/components/schemas/Profile"
2653
+ },
2654
+ "revocation": {
2655
+ "$ref": "#/components/schemas/Revocation"
2656
+ },
2657
+ "seat": {
2658
+ "$ref": "#/components/schemas/Seat"
2659
+ },
2660
+ "serial_number": {
2661
+ "type": "string"
2662
+ },
2663
+ "session_key": {
2664
+ "type": "string"
2665
+ },
2666
+ "status": {
2667
+ "type": "string"
2668
+ },
2669
+ "valid_from": {
2670
+ "type": "string"
2671
+ },
2672
+ "valid_to": {
2673
+ "type": "string"
2674
+ },
2675
+ "webpin": {
2676
+ "type": "string"
2677
+ }
2678
+ }
2679
+ },
2680
+ "GetEnrollStatusResponse": {
2681
+ "title": "GetEnrollStatusResponse",
2682
+ "type": "object",
2683
+ "properties": {
2684
+ "certificates": {
2685
+ "type": "array",
2686
+ "items": {
2687
+ "type": "string"
2688
+ },
2689
+ "description": ""
2690
+ },
2691
+ "created_at": {
2692
+ "type": "string"
2693
+ },
2694
+ "profile_id": {
2695
+ "type": "string"
2696
+ },
2697
+ "status": {
2698
+ "type": "string"
2699
+ },
2700
+ "updated_at": {
2701
+ "type": "string"
2702
+ }
2703
+ }
2704
+ },
2705
+ "GetProfileResponse": {
2706
+ "title": "GetProfileResponse",
2707
+ "type": "object",
2708
+ "properties": {
2709
+ "authentication": {
2710
+ "$ref": "#/components/schemas/Authentication"
2711
+ },
2712
+ "certificate": {
2713
+ "$ref": "#/components/schemas/CertificateDetails"
2714
+ },
2715
+ "certificate_delivery_format": {
2716
+ "type": "string"
2717
+ },
2718
+ "duplicate_cert_policy": {
2719
+ "type": "boolean"
2720
+ },
2721
+ "enrollment": {
2722
+ "$ref": "#/components/schemas/Enrollment"
2723
+ },
2724
+ "id": {
2725
+ "type": "string"
2726
+ },
2727
+ "name": {
2728
+ "type": "string"
2729
+ },
2730
+ "private_key_attributes": {
2731
+ "$ref": "#/components/schemas/PrivateKeyAttributes"
2732
+ },
2733
+ "publish_to_public_directory": {
2734
+ "type": "boolean"
2735
+ },
2736
+ "renewal_period_days": {
2737
+ "type": "integer",
2738
+ "format": "int32"
2739
+ },
2740
+ "signature_algorithm": {
2741
+ "type": "string"
2742
+ },
2743
+ "status": {
2744
+ "type": "string"
2745
+ }
2746
+ }
2747
+ },
2748
+ "Issuer": {
2749
+ "title": "Issuer",
2750
+ "type": "object",
2751
+ "properties": {
2752
+ "certificate": {
2753
+ "type": "string"
2754
+ },
2755
+ "chain": {
2756
+ "type": "array",
2757
+ "items": {
2758
+ "$ref": "#/components/schemas/CertificateInfo"
2759
+ },
2760
+ "description": ""
2761
+ },
2762
+ "root": {
2763
+ "type": "boolean"
2764
+ },
2765
+ "serial_number": {
2766
+ "type": "string"
2767
+ },
2768
+ "subject_dn": {
2769
+ "type": "string"
2770
+ }
2771
+ }
2772
+ },
2773
+ "KeyEscrowPolicy": {
2774
+ "title": "KeyEscrowPolicy",
2775
+ "type": "object",
2776
+ "properties": {
2777
+ "dual_admin_recovery": {
2778
+ "type": "boolean"
2779
+ },
2780
+ "key_escrow_deployment_mode": {
2781
+ "$ref": "#/components/schemas/KeyEscrowDeploymentMode"
2782
+ },
2783
+ "key_escrow_enabled": {
2784
+ "type": "boolean"
2785
+ }
2786
+ }
2787
+ },
2788
+ "KeyEscrowPolicyType": {
2789
+ "title": "KeyEscrowPolicyType",
2790
+ "type": "object",
2791
+ "properties": {
2792
+ "do_key_recovery_for_additional_enroll_request": {
2793
+ "type": "boolean"
2794
+ },
2795
+ "key_escrow_deployment_mode": {
2796
+ "type": "string"
2797
+ },
2798
+ "key_escrow_enabled": {
2799
+ "type": "boolean"
2800
+ },
2801
+ "key_recovery_dual_admin_approval_required": {
2802
+ "type": "boolean"
2803
+ }
2804
+ }
2805
+ },
2806
+ "KeyUsageListType": {
2807
+ "title": "KeyUsageListType",
2808
+ "type": "object",
2809
+ "properties": {
2810
+ "critical": {
2811
+ "type": "boolean"
2812
+ },
2813
+ "key_usages": {
2814
+ "type": "array",
2815
+ "items": {
2816
+ "type": "string"
2817
+ },
2818
+ "description": ""
2819
+ }
2820
+ }
2821
+ },
2822
+ "PrivateKeyAttributes": {
2823
+ "title": "PrivateKeyAttributes",
2824
+ "type": "object",
2825
+ "properties": {
2826
+ "algorithm_oid": {
2827
+ "type": "string"
2828
+ },
2829
+ "crypto_providers": {
2830
+ "$ref": "#/components/schemas/CryptoProviders"
2831
+ },
2832
+ "key_escrow_policy": {
2833
+ "$ref": "#/components/schemas/KeyEscrowPolicyType"
2834
+ },
2835
+ "key_exportable": {
2836
+ "type": "boolean"
2837
+ },
2838
+ "key_protect": {
2839
+ "type": "boolean"
2840
+ },
2841
+ "key_size": {
2842
+ "type": "integer",
2843
+ "format": "int32"
2844
+ },
2845
+ "key_sizes": {
2846
+ "type": "array",
2847
+ "items": {
2848
+ "type": "integer",
2849
+ "format": "int32"
2850
+ },
2851
+ "description": ""
2852
+ }
2853
+ }
2854
+ },
2855
+ "Profile": {
2856
+ "title": "Profile",
2857
+ "type": "object",
2858
+ "properties": {
2859
+ "id": {
2860
+ "type": "string"
2861
+ },
2862
+ "name": {
2863
+ "type": "string"
2864
+ }
2865
+ }
2866
+ },
2867
+ "ProfileCreationRequest": {
2868
+ "title": "ProfileCreationRequest",
2869
+ "type": "object",
2870
+ "properties": {
2871
+ "bctOid": {
2872
+ "type": "string"
2873
+ },
2874
+ "caId": {
2875
+ "type": "string"
2876
+ },
2877
+ "duplicateCertPolicy": {
2878
+ "type": "boolean"
2879
+ },
2880
+ "extendedKeyUsages": {
2881
+ "$ref": "#/components/schemas/ExtendedKeyUsageListType"
2882
+ },
2883
+ "keyEscrowPolicy": {
2884
+ "$ref": "#/components/schemas/KeyEscrowPolicy"
2885
+ },
2886
+ "keySize": {
2887
+ "type": "string"
2888
+ },
2889
+ "keyUsages": {
2890
+ "$ref": "#/components/schemas/KeyUsageListType"
2891
+ },
2892
+ "overrideCertValidityViaApi": {
2893
+ "type": "boolean"
2894
+ },
2895
+ "profileName": {
2896
+ "type": "string"
2897
+ },
2898
+ "profileOid": {
2899
+ "type": "string"
2900
+ },
2901
+ "renewalPeriodDays": {
2902
+ "type": "integer",
2903
+ "format": "int32"
2904
+ },
2905
+ "san": {
2906
+ "$ref": "#/components/schemas/San"
2907
+ },
2908
+ "signatureAlgorithm": {
2909
+ "type": "string"
2910
+ },
2911
+ "subject": {
2912
+ "$ref": "#/components/schemas/Subject"
2913
+ },
2914
+ "validity": {
2915
+ "$ref": "#/components/schemas/Validity"
2916
+ }
2917
+ }
2918
+ },
2919
+ "RequestCertificateRequest": {
2920
+ "title": "RequestCertificateRequest",
2921
+ "type": "object",
2922
+ "properties": {
2923
+ "attributes": {
2924
+ "$ref": "#/components/schemas/CertificateAttributes"
2925
+ },
2926
+ "authentication": {
2927
+ "type": "object",
2928
+ "additionalProperties": {
2929
+ "type": "string"
2930
+ }
2931
+ },
2932
+ "csr": {
2933
+ "type": "string"
2934
+ },
2935
+ "profile": {
2936
+ "$ref": "#/components/schemas/Profile"
2937
+ },
2938
+ "seat": {
2939
+ "$ref": "#/components/schemas/Seat"
2940
+ },
2941
+ "session_key": {
2942
+ "type": "string"
2943
+ },
2944
+ "validity": {
2945
+ "$ref": "#/components/schemas/Validity"
2946
+ }
2947
+ }
2948
+ },
2949
+ "ResetPasscodeRequest": {
2950
+ "title": "ResetPasscodeRequest",
2951
+ "type": "object",
2952
+ "properties": {
2953
+ "seat": {
2954
+ "$ref": "#/components/schemas/Seat"
2955
+ }
2956
+ }
2957
+ },
2958
+ "Revocation": {
2959
+ "title": "Revocation",
2960
+ "type": "object",
2961
+ "properties": {
2962
+ "comments": {
2963
+ "type": "string"
2964
+ },
2965
+ "reason": {
2966
+ "type": "string"
2967
+ },
2968
+ "revocation_date": {
2969
+ "type": "string"
2970
+ }
2971
+ }
2972
+ },
2973
+ "RevokeCertificateRequest": {
2974
+ "title": "RevokeCertificateRequest",
2975
+ "type": "object",
2976
+ "properties": {
2977
+ "revocation_reason": {
2978
+ "type": "string"
2979
+ }
2980
+ }
2981
+ },
2982
+ "San": {
2983
+ "title": "San",
2984
+ "type": "object",
2985
+ "properties": {
2986
+ "attributes": {
2987
+ "type": "array",
2988
+ "items": {
2989
+ "$ref": "#/components/schemas/Attribute"
2990
+ },
2991
+ "description": ""
2992
+ },
2993
+ "critical": {
2994
+ "type": "boolean"
2995
+ }
2996
+ }
2997
+ },
2998
+ "SanAttributes": {
2999
+ "title": "SanAttributes",
3000
+ "type": "object",
3001
+ "properties": {
3002
+ "custom_attributes": {
3003
+ "type": "object",
3004
+ "additionalProperties": {
3005
+ "type": "string"
3006
+ }
3007
+ },
3008
+ "directory_name": {
3009
+ "type": "string"
3010
+ },
3011
+ "dns_name": {
3012
+ "type": "array",
3013
+ "items": {
3014
+ "$ref": "#/components/schemas/Attribute"
3015
+ },
3016
+ "description": ""
3017
+ },
3018
+ "ip_address": {
3019
+ "type": "array",
3020
+ "items": {
3021
+ "$ref": "#/components/schemas/Attribute"
3022
+ },
3023
+ "description": ""
3024
+ },
3025
+ "other_name": {
3026
+ "type": "array",
3027
+ "items": {
3028
+ "$ref": "#/components/schemas/Attribute"
3029
+ },
3030
+ "description": ""
3031
+ },
3032
+ "registered_id": {
3033
+ "type": "array",
3034
+ "items": {
3035
+ "$ref": "#/components/schemas/Attribute"
3036
+ },
3037
+ "description": ""
3038
+ },
3039
+ "rfc822_name": {
3040
+ "type": "array",
3041
+ "items": {
3042
+ "$ref": "#/components/schemas/Attribute"
3043
+ },
3044
+ "description": ""
3045
+ },
3046
+ "user_principal_name": {
3047
+ "type": "array",
3048
+ "items": {
3049
+ "$ref": "#/components/schemas/Attribute"
3050
+ },
3051
+ "description": ""
3052
+ }
3053
+ }
3054
+ },
3055
+ "SearchCertificateRequest": {
3056
+ "title": "SearchCertificateRequest",
3057
+ "type": "object",
3058
+ "properties": {
3059
+ "common_name": {
3060
+ "type": "string"
3061
+ },
3062
+ "email": {
3063
+ "type": "string"
3064
+ },
3065
+ "issuing_ca": {
3066
+ "type": "string"
3067
+ },
3068
+ "profile_id": {
3069
+ "type": "string"
3070
+ },
3071
+ "seat_id": {
3072
+ "type": "string"
3073
+ },
3074
+ "serial_number": {
3075
+ "type": "string"
3076
+ },
3077
+ "start_index": {
3078
+ "type": "integer",
3079
+ "format": "int32"
3080
+ },
3081
+ "status": {
3082
+ "type": "string"
3083
+ },
3084
+ "valid_from": {
3085
+ "type": "string"
3086
+ },
3087
+ "valid_to": {
3088
+ "type": "string"
3089
+ }
3090
+ }
3091
+ },
3092
+ "SearchCertificateResponse": {
3093
+ "title": "SearchCertificateResponse",
3094
+ "type": "object",
3095
+ "properties": {
3096
+ "certificates": {
3097
+ "type": "array",
3098
+ "items": {
3099
+ "$ref": "#/components/schemas/GetCertificateResponse"
3100
+ },
3101
+ "description": ""
3102
+ },
3103
+ "count": {
3104
+ "type": "integer",
3105
+ "format": "int32"
3106
+ },
3107
+ "index": {
3108
+ "type": "integer",
3109
+ "format": "int32"
3110
+ },
3111
+ "more_certs_available": {
3112
+ "type": "boolean"
3113
+ }
3114
+ }
3115
+ },
3116
+ "Seat": {
3117
+ "title": "Seat",
3118
+ "type": "object",
3119
+ "properties": {
3120
+ "email": {
3121
+ "type": "string"
3122
+ },
3123
+ "seat_id": {
3124
+ "type": "string"
3125
+ },
3126
+ "seat_name": {
3127
+ "type": "string"
3128
+ }
3129
+ }
3130
+ },
3131
+ "Subject": {
3132
+ "title": "Subject",
3133
+ "type": "object",
3134
+ "properties": {
3135
+ "attributes": {
3136
+ "type": "array",
3137
+ "items": {
3138
+ "$ref": "#/components/schemas/ExtendedAttribute"
3139
+ },
3140
+ "description": ""
3141
+ }
3142
+ }
3143
+ },
3144
+ "UpdateSeatRequest": {
3145
+ "title": "UpdateSeatRequest",
3146
+ "type": "object",
3147
+ "properties": {
3148
+ "email": {
3149
+ "type": "string"
3150
+ },
3151
+ "phone": {
3152
+ "type": "string"
3153
+ },
3154
+ "seat_name": {
3155
+ "type": "string"
3156
+ }
3157
+ }
3158
+ },
3159
+ "Validity": {
3160
+ "title": "Validity",
3161
+ "type": "object",
3162
+ "properties": {
3163
+ "duration": {
3164
+ "type": "integer",
3165
+ "format": "int32"
3166
+ },
3167
+ "unit": {
3168
+ "type": "string"
3169
+ }
3170
+ }
3171
+ },
3172
+ "KeyEscrowDeploymentMode": {
3173
+ "title": "KeyEscrowDeploymentMode",
3174
+ "enum": [
3175
+ "CLOUD",
3176
+ "LOCAL"
3177
+ ],
3178
+ "type": "string"
3179
+ }
3180
+ }
3181
+ },
3182
+ "tags": [
3183
+ {
3184
+ "name": "Audit API",
3185
+ "description": "Audit Controller"
3186
+ },
3187
+ {
3188
+ "name": "CA API",
3189
+ "description": "Ca Controller"
3190
+ },
3191
+ {
3192
+ "name": "Certificate Enrollment API",
3193
+ "description": "Certificate Controller"
3194
+ },
3195
+ {
3196
+ "name": "Certificate Profile API",
3197
+ "description": "Profile Controller"
3198
+ },
3199
+ {
3200
+ "name": "Enroll Status API",
3201
+ "description": "Enroll Status Controller"
3202
+ },
3203
+ {
3204
+ "name": "Hello API",
3205
+ "description": "Hello Controller"
3206
+ },
3207
+ {
3208
+ "name": "PROFILE API",
3209
+ "description": "Profile Creation Controller"
3210
+ },
3211
+ {
3212
+ "name": "Search Certificate API",
3213
+ "description": "Search Certificate Controller"
3214
+ },
3215
+ {
3216
+ "name": "Seat Management API",
3217
+ "description": "Seat Management Controller"
3218
+ },
3219
+ {
3220
+ "name": "User Management API",
3221
+ "description": "User Management Controller"
3222
+ }
3223
+ ]
3224
+ }