@itentialopensource/adapter-digicert_pki 0.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 (87) hide show
  1. package/.eslintignore +6 -0
  2. package/.eslintrc.js +18 -0
  3. package/.gitlab/.gitkeep +0 -0
  4. package/.gitlab/issue_templates/.gitkeep +0 -0
  5. package/.gitlab/issue_templates/Default.md +17 -0
  6. package/.gitlab/issue_templates/bugReportTemplate.md +76 -0
  7. package/.gitlab/issue_templates/featureRequestTemplate.md +14 -0
  8. package/.jshintrc +0 -0
  9. package/AUTH.md +39 -0
  10. package/BROKER.md +199 -0
  11. package/CALLS.md +356 -0
  12. package/CHANGELOG.md +9 -0
  13. package/CODE_OF_CONDUCT.md +43 -0
  14. package/CONTRIBUTING.md +172 -0
  15. package/ENHANCE.md +69 -0
  16. package/LICENSE +201 -0
  17. package/PROPERTIES.md +641 -0
  18. package/README.md +337 -0
  19. package/SUMMARY.md +9 -0
  20. package/SYSTEMINFO.md +11 -0
  21. package/TROUBLESHOOT.md +47 -0
  22. package/adapter.js +3945 -0
  23. package/adapterBase.js +1787 -0
  24. package/entities/.generic/action.json +214 -0
  25. package/entities/.generic/schema.json +28 -0
  26. package/entities/.system/action.json +50 -0
  27. package/entities/.system/mockdatafiles/getToken-default.json +3 -0
  28. package/entities/.system/mockdatafiles/healthcheck-default.json +3 -0
  29. package/entities/.system/schema.json +19 -0
  30. package/entities/.system/schemaTokenReq.json +53 -0
  31. package/entities/.system/schemaTokenResp.json +53 -0
  32. package/entities/AuditAPI/action.json +46 -0
  33. package/entities/AuditAPI/schema.json +20 -0
  34. package/entities/CAAPI/action.json +46 -0
  35. package/entities/CAAPI/schema.json +20 -0
  36. package/entities/CertificateEnrollmentAPI/action.json +166 -0
  37. package/entities/CertificateEnrollmentAPI/schema.json +26 -0
  38. package/entities/CertificateProfileAPI/action.json +46 -0
  39. package/entities/CertificateProfileAPI/mockdatafiles/getAllProfilesUsingGET-default.json +1288 -0
  40. package/entities/CertificateProfileAPI/schema.json +20 -0
  41. package/entities/EnrollStatusAPI/action.json +25 -0
  42. package/entities/EnrollStatusAPI/mockdatafiles/enrollStatusUsingGET-default.json +17 -0
  43. package/entities/EnrollStatusAPI/schema.json +30 -0
  44. package/entities/HelloAPI/action.json +25 -0
  45. package/entities/HelloAPI/schema.json +19 -0
  46. package/entities/PROFILEAPI/action.json +124 -0
  47. package/entities/PROFILEAPI/schema.json +24 -0
  48. package/entities/SearchCertificateAPI/action.json +24 -0
  49. package/entities/SearchCertificateAPI/schema.json +19 -0
  50. package/entities/SeatManagementAPI/action.json +85 -0
  51. package/entities/SeatManagementAPI/schema.json +22 -0
  52. package/entities/UserManagementAPI/action.json +85 -0
  53. package/entities/UserManagementAPI/schema.json +33 -0
  54. package/error.json +190 -0
  55. package/package.json +86 -0
  56. package/pronghorn.json +4141 -0
  57. package/propertiesDecorators.json +14 -0
  58. package/propertiesSchema.json +1248 -0
  59. package/refs?service=git-upload-pack +0 -0
  60. package/report/DigiCert One Swagger v1.0.44.json +1 -0
  61. package/report/adapterInfo.json +10 -0
  62. package/report/creationReport.json +490 -0
  63. package/sampleProperties.json +195 -0
  64. package/test/integration/adapterTestBasicGet.js +83 -0
  65. package/test/integration/adapterTestConnectivity.js +93 -0
  66. package/test/integration/adapterTestIntegration.js +1867 -0
  67. package/test/unit/adapterBaseTestUnit.js +949 -0
  68. package/test/unit/adapterTestUnit.js +2278 -0
  69. package/utils/adapterInfo.js +206 -0
  70. package/utils/addAuth.js +94 -0
  71. package/utils/artifactize.js +146 -0
  72. package/utils/basicGet.js +50 -0
  73. package/utils/checkMigrate.js +63 -0
  74. package/utils/entitiesToDB.js +178 -0
  75. package/utils/findPath.js +74 -0
  76. package/utils/methodDocumentor.js +225 -0
  77. package/utils/modify.js +154 -0
  78. package/utils/packModificationScript.js +35 -0
  79. package/utils/patches2bundledDeps.js +90 -0
  80. package/utils/pre-commit.sh +32 -0
  81. package/utils/removeHooks.js +20 -0
  82. package/utils/setup.js +33 -0
  83. package/utils/tbScript.js +246 -0
  84. package/utils/tbUtils.js +490 -0
  85. package/utils/testRunner.js +298 -0
  86. package/utils/troubleshootingAdapter.js +195 -0
  87. package/workflows/README.md +3 -0
package/pronghorn.json ADDED
@@ -0,0 +1,4141 @@
1
+ {
2
+ "id": "@itentialopensource/adapter-digicert_pki",
3
+ "type": "Adapter",
4
+ "export": "Digicert",
5
+ "title": "Digicert",
6
+ "src": "adapter.js",
7
+ "roles": [
8
+ "admin"
9
+ ],
10
+ "methods": [
11
+ {
12
+ "name": "iapUpdateAdapterConfiguration",
13
+ "summary": "Updates the adapter configuration",
14
+ "description": "Updates the adapter configuration file with the provided changes",
15
+ "input": [
16
+ {
17
+ "name": "configFile",
18
+ "type": "string",
19
+ "info": "The name of the file to change",
20
+ "required": true,
21
+ "schema": {
22
+ "title": "configFile",
23
+ "type": "string"
24
+ }
25
+ },
26
+ {
27
+ "name": "changes",
28
+ "type": "object",
29
+ "info": "JSON object containing the configuration changes",
30
+ "required": true,
31
+ "schema": {
32
+ "title": "changes",
33
+ "type": "object"
34
+ }
35
+ },
36
+ {
37
+ "name": "entity",
38
+ "type": "string",
39
+ "info": "The entity in which the changes are being made",
40
+ "required": false,
41
+ "schema": {
42
+ "title": "entity",
43
+ "type": "string"
44
+ }
45
+ },
46
+ {
47
+ "name": "type",
48
+ "type": "string",
49
+ "info": "The type of file to change - action, schema, or mock",
50
+ "required": false,
51
+ "schema": {
52
+ "title": "type",
53
+ "type": "string"
54
+ }
55
+ },
56
+ {
57
+ "name": "action",
58
+ "type": "string",
59
+ "info": "The action to be changed",
60
+ "required": false,
61
+ "schema": {
62
+ "title": "action",
63
+ "type": "string"
64
+ }
65
+ }
66
+ ],
67
+ "output": {
68
+ "name": "result",
69
+ "type": "object",
70
+ "description": "A JSON Object containing status, code and the result",
71
+ "schema": {
72
+ "title": "result",
73
+ "type": "object"
74
+ }
75
+ },
76
+ "roles": [
77
+ "admin"
78
+ ],
79
+ "route": {
80
+ "verb": "POST",
81
+ "path": "/iapUpdateAdapterConfiguration"
82
+ },
83
+ "task": true
84
+ },
85
+ {
86
+ "name": "iapFindAdapterPath",
87
+ "summary": "Provides the ability to see if a particular API path is supported by the adapter",
88
+ "description": "Provides the ability to see if a particular API path is supported by the adapter",
89
+ "input": [
90
+ {
91
+ "name": "apiPath",
92
+ "type": "string",
93
+ "info": "The API Path you want to check - make sure to not include base path and version",
94
+ "description": "The API Path you want to check - make sure to not include base path and version",
95
+ "schema": {
96
+ "title": "apiPath",
97
+ "type": "string"
98
+ },
99
+ "required": true
100
+ }
101
+ ],
102
+ "output": {
103
+ "name": "result",
104
+ "type": "object",
105
+ "description": "A JSON Object containing the result",
106
+ "schema": {
107
+ "title": "result",
108
+ "type": "object"
109
+ }
110
+ },
111
+ "roles": [
112
+ "admin"
113
+ ],
114
+ "route": {
115
+ "verb": "POST",
116
+ "path": "/iapFindAdapterPath"
117
+ },
118
+ "task": true
119
+ },
120
+ {
121
+ "name": "iapSuspendAdapter",
122
+ "summary": "Suspends the adapter",
123
+ "description": "Suspends the adapter",
124
+ "input": [
125
+ {
126
+ "name": "mode",
127
+ "type": "enum",
128
+ "enumerals": [
129
+ "pause",
130
+ "error"
131
+ ],
132
+ "info": "How incoming requests are handled. Defaults to 'pause'",
133
+ "description": "How incoming requests are handled. Defaults to 'pause'",
134
+ "schema": {
135
+ "title": "mode",
136
+ "type": "string"
137
+ },
138
+ "required": false
139
+ }
140
+ ],
141
+ "output": {
142
+ "name": "result",
143
+ "type": "object",
144
+ "description": "A JSON Object containing the adapter suspended status",
145
+ "schema": {
146
+ "title": "result",
147
+ "type": "object"
148
+ }
149
+ },
150
+ "roles": [
151
+ "admin"
152
+ ],
153
+ "route": {
154
+ "verb": "POST",
155
+ "path": "/iapSuspendAdapter"
156
+ },
157
+ "task": true
158
+ },
159
+ {
160
+ "name": "iapUnsuspendAdapter",
161
+ "summary": "Unsuspends the adapter",
162
+ "description": "Unsuspends the adapter",
163
+ "input": [],
164
+ "output": {
165
+ "name": "result",
166
+ "type": "object",
167
+ "description": "A JSON Object containing the adapter suspended status",
168
+ "schema": {
169
+ "title": "result",
170
+ "type": "object"
171
+ }
172
+ },
173
+ "roles": [
174
+ "admin"
175
+ ],
176
+ "route": {
177
+ "verb": "POST",
178
+ "path": "/iapUnsuspendAdapter"
179
+ },
180
+ "task": true
181
+ },
182
+ {
183
+ "name": "iapGetAdapterQueue",
184
+ "summary": "Return the requests that are waiting in the queue if throttling is enabled",
185
+ "description": "Return the requests that are waiting in the queue if throttling is enabled",
186
+ "input": [],
187
+ "output": {
188
+ "name": "result",
189
+ "type": "object",
190
+ "description": "A JSON Object containing the adapter queue",
191
+ "schema": {
192
+ "title": "result",
193
+ "type": "object"
194
+ }
195
+ },
196
+ "roles": [
197
+ "admin"
198
+ ],
199
+ "route": {
200
+ "verb": "POST",
201
+ "path": "/iapGetAdapterQueue"
202
+ },
203
+ "task": true
204
+ },
205
+ {
206
+ "name": "iapTroubleshootAdapter",
207
+ "summary": "Runs troubleshoot script for adapter",
208
+ "description": "Runs troubleshoot script for adapter",
209
+ "input": [
210
+ {
211
+ "name": "props",
212
+ "type": "object",
213
+ "info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}",
214
+ "required": true,
215
+ "schema": {
216
+ "title": "props",
217
+ "type": "object"
218
+ }
219
+ },
220
+ {
221
+ "name": "persistFlag",
222
+ "type": "boolean",
223
+ "info": "Whether the input properties should be saved",
224
+ "required": true
225
+ }
226
+ ],
227
+ "output": {
228
+ "name": "result",
229
+ "type": "object",
230
+ "description": "A JSON Object containing the test results",
231
+ "schema": {
232
+ "title": "result",
233
+ "type": "object"
234
+ }
235
+ },
236
+ "roles": [
237
+ "admin"
238
+ ],
239
+ "route": {
240
+ "verb": "POST",
241
+ "path": "/iapTroubleshootAdapter"
242
+ },
243
+ "task": true
244
+ },
245
+ {
246
+ "name": "iapRunAdapterHealthcheck",
247
+ "summary": "Runs healthcheck script for adapter",
248
+ "description": "Runs healthcheck script for adapter",
249
+ "input": [],
250
+ "output": {
251
+ "name": "result",
252
+ "type": "boolean",
253
+ "description": "Whether healthcheck passed or failed"
254
+ },
255
+ "roles": [
256
+ "admin"
257
+ ],
258
+ "route": {
259
+ "verb": "POST",
260
+ "path": "/iapRunAdapterHealthcheck"
261
+ },
262
+ "task": true
263
+ },
264
+ {
265
+ "name": "iapRunAdapterConnectivity",
266
+ "summary": "Runs connectivity check script for adapter",
267
+ "description": "Runs connectivity check script for adapter",
268
+ "input": [],
269
+ "output": {
270
+ "name": "result",
271
+ "type": "object",
272
+ "description": "A JSON Object containing the test results",
273
+ "schema": {
274
+ "title": "result",
275
+ "type": "object"
276
+ }
277
+ },
278
+ "roles": [
279
+ "admin"
280
+ ],
281
+ "route": {
282
+ "verb": "POST",
283
+ "path": "/iapRunAdapterConnectivity"
284
+ },
285
+ "task": true
286
+ },
287
+ {
288
+ "name": "iapRunAdapterBasicGet",
289
+ "summary": "Runs basicGet script for adapter",
290
+ "description": "Runs basicGet script for adapter",
291
+ "input": [],
292
+ "output": {
293
+ "name": "result",
294
+ "type": "object",
295
+ "description": "A JSON Object containing the test results",
296
+ "schema": {
297
+ "title": "result",
298
+ "type": "object"
299
+ }
300
+ },
301
+ "roles": [
302
+ "admin"
303
+ ],
304
+ "route": {
305
+ "verb": "POST",
306
+ "path": "/iapRunAdapterBasicGet"
307
+ },
308
+ "task": true
309
+ },
310
+ {
311
+ "name": "iapMoveAdapterEntitiesToDB",
312
+ "summary": "Moves entities from an adapter into the IAP database",
313
+ "description": "Moves entities from an adapter into the IAP database",
314
+ "input": [],
315
+ "output": {
316
+ "name": "res",
317
+ "type": "object",
318
+ "description": "A JSON Object containing status, code and the response from the mongo transaction",
319
+ "schema": {
320
+ "title": "res",
321
+ "type": "object"
322
+ }
323
+ },
324
+ "roles": [
325
+ "admin"
326
+ ],
327
+ "route": {
328
+ "verb": "POST",
329
+ "path": "/iapMoveAdapterEntitiesToDB"
330
+ },
331
+ "task": true
332
+ },
333
+ {
334
+ "name": "genericAdapterRequest",
335
+ "summary": "Makes the requested generic call",
336
+ "description": "Makes the requested generic call",
337
+ "input": [
338
+ {
339
+ "name": "uriPath",
340
+ "type": "string",
341
+ "info": "the path of the api call - do not include the host, port, base path or version",
342
+ "description": "the path of the api call",
343
+ "schema": {
344
+ "title": "uriPath",
345
+ "type": "string"
346
+ },
347
+ "required": true
348
+ },
349
+ {
350
+ "name": "restMethod",
351
+ "type": "string",
352
+ "info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
353
+ "description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
354
+ "schema": {
355
+ "title": "restMethod",
356
+ "type": "string"
357
+ },
358
+ "required": true
359
+ },
360
+ {
361
+ "name": "queryData",
362
+ "type": "object",
363
+ "info": "the query parameters to be put on the url (optional)",
364
+ "description": "the query parameters to be put on the url (optional)",
365
+ "schema": {
366
+ "title": "queryData",
367
+ "type": "object"
368
+ },
369
+ "required": false
370
+ },
371
+ {
372
+ "name": "requestBody",
373
+ "type": "object",
374
+ "info": "the payload to be sent with the request (optional)",
375
+ "description": "the payload to be sent with the request (optional)",
376
+ "schema": {
377
+ "title": "requestBody",
378
+ "type": "object"
379
+ },
380
+ "required": false
381
+ },
382
+ {
383
+ "name": "addlHeaders",
384
+ "type": "object",
385
+ "info": "additional headers to be put on the call (optional)",
386
+ "description": "additional headers to be put on the call (optional)",
387
+ "schema": {
388
+ "title": "addlHeaders",
389
+ "type": "object"
390
+ },
391
+ "required": false
392
+ }
393
+ ],
394
+ "output": {
395
+ "name": "result",
396
+ "type": "object",
397
+ "description": "A JSON Object containing status, code and the result",
398
+ "schema": {
399
+ "title": "result",
400
+ "type": "object"
401
+ }
402
+ },
403
+ "roles": [
404
+ "admin"
405
+ ],
406
+ "route": {
407
+ "verb": "POST",
408
+ "path": "/genericAdapterRequest"
409
+ },
410
+ "task": true
411
+ },
412
+ {
413
+ "name": "genericAdapterRequestNoBasePath",
414
+ "summary": "Makes the requested generic call",
415
+ "description": "Makes the requested generic call",
416
+ "input": [
417
+ {
418
+ "name": "uriPath",
419
+ "type": "string",
420
+ "info": "the path of the api call - do not include the host, port, base path or version",
421
+ "description": "the path of the api call",
422
+ "schema": {
423
+ "title": "uriPath",
424
+ "type": "string"
425
+ },
426
+ "required": true
427
+ },
428
+ {
429
+ "name": "restMethod",
430
+ "type": "string",
431
+ "info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
432
+ "description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
433
+ "schema": {
434
+ "title": "restMethod",
435
+ "type": "string"
436
+ },
437
+ "required": true
438
+ },
439
+ {
440
+ "name": "queryData",
441
+ "type": "object",
442
+ "info": "the query parameters to be put on the url (optional)",
443
+ "description": "the query parameters to be put on the url (optional)",
444
+ "schema": {
445
+ "title": "queryData",
446
+ "type": "object"
447
+ },
448
+ "required": false
449
+ },
450
+ {
451
+ "name": "requestBody",
452
+ "type": "object",
453
+ "info": "the payload to be sent with the request (optional)",
454
+ "description": "the payload to be sent with the request (optional)",
455
+ "schema": {
456
+ "title": "requestBody",
457
+ "type": "object"
458
+ },
459
+ "required": false
460
+ },
461
+ {
462
+ "name": "addlHeaders",
463
+ "type": "object",
464
+ "info": "additional headers to be put on the call (optional)",
465
+ "description": "additional headers to be put on the call (optional)",
466
+ "schema": {
467
+ "title": "addlHeaders",
468
+ "type": "object"
469
+ },
470
+ "required": false
471
+ }
472
+ ],
473
+ "output": {
474
+ "name": "result",
475
+ "type": "object",
476
+ "description": "A JSON Object containing status, code and the result",
477
+ "schema": {
478
+ "title": "result",
479
+ "type": "object"
480
+ }
481
+ },
482
+ "roles": [
483
+ "admin"
484
+ ],
485
+ "route": {
486
+ "verb": "POST",
487
+ "path": "/genericAdapterRequestNoBasePath"
488
+ },
489
+ "task": true
490
+ },
491
+ {
492
+ "name": "getDevice",
493
+ "summary": "Get the Appliance",
494
+ "description": "Get the Appliance",
495
+ "input": [
496
+ {
497
+ "name": "deviceName",
498
+ "type": "string",
499
+ "info": "An Appliance Device Name",
500
+ "required": true,
501
+ "schema": {
502
+ "title": "deviceName",
503
+ "type": "string"
504
+ }
505
+ }
506
+ ],
507
+ "output": {
508
+ "name": "result",
509
+ "type": "object",
510
+ "description": "A JSON Object containing status, code and the result",
511
+ "schema": {
512
+ "title": "result",
513
+ "type": "object"
514
+ }
515
+ },
516
+ "roles": [
517
+ "admin"
518
+ ],
519
+ "route": {
520
+ "verb": "POST",
521
+ "path": "/getDevice"
522
+ },
523
+ "task": true
524
+ },
525
+ {
526
+ "name": "getDevicesFiltered",
527
+ "summary": "Get Appliances that match the filter",
528
+ "description": "Get Appliances that match the filter",
529
+ "input": [
530
+ {
531
+ "name": "options",
532
+ "type": "object",
533
+ "info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }",
534
+ "required": true,
535
+ "schema": {
536
+ "title": "options",
537
+ "type": "object"
538
+ }
539
+ }
540
+ ],
541
+ "output": {
542
+ "name": "result",
543
+ "type": "array",
544
+ "description": "A JSON Object containing status, code and the result",
545
+ "schema": {
546
+ "title": "result",
547
+ "type": "array"
548
+ }
549
+ },
550
+ "roles": [
551
+ "admin"
552
+ ],
553
+ "route": {
554
+ "verb": "POST",
555
+ "path": "/getDevicesFiltered"
556
+ },
557
+ "task": true
558
+ },
559
+ {
560
+ "name": "isAlive",
561
+ "summary": "Checks the status for the provided Appliance",
562
+ "description": "Checks the status for the provided Appliance",
563
+ "input": [
564
+ {
565
+ "name": "deviceName",
566
+ "type": "string",
567
+ "info": "An Appliance Device Name",
568
+ "required": true,
569
+ "schema": {
570
+ "title": "deviceName",
571
+ "type": "string"
572
+ }
573
+ }
574
+ ],
575
+ "output": {
576
+ "name": "result",
577
+ "type": "boolean",
578
+ "description": "A JSON Object containing status, code and the result",
579
+ "schema": {
580
+ "title": "result",
581
+ "type": "boolean"
582
+ }
583
+ },
584
+ "roles": [
585
+ "admin"
586
+ ],
587
+ "route": {
588
+ "verb": "POST",
589
+ "path": "/isAlive"
590
+ },
591
+ "task": true
592
+ },
593
+ {
594
+ "name": "getConfig",
595
+ "summary": "Gets a config for the provided Appliance",
596
+ "description": "Gets a config for the provided Appliance",
597
+ "input": [
598
+ {
599
+ "name": "deviceName",
600
+ "type": "string",
601
+ "info": "An Appliance Device Name",
602
+ "required": true,
603
+ "schema": {
604
+ "title": "deviceName",
605
+ "type": "string"
606
+ }
607
+ },
608
+ {
609
+ "name": "format",
610
+ "type": "string",
611
+ "info": "The format to be returned - this is ignored as we always return json",
612
+ "required": false,
613
+ "schema": {
614
+ "title": "format",
615
+ "type": "string"
616
+ }
617
+ }
618
+ ],
619
+ "output": {
620
+ "name": "result",
621
+ "type": "object",
622
+ "description": "A JSON Object containing status, code and the result",
623
+ "schema": {
624
+ "title": "result",
625
+ "type": "object"
626
+ }
627
+ },
628
+ "roles": [
629
+ "admin"
630
+ ],
631
+ "route": {
632
+ "verb": "POST",
633
+ "path": "/getConfig"
634
+ },
635
+ "task": true
636
+ },
637
+ {
638
+ "name": "iapGetDeviceCount",
639
+ "summary": "Gets a device count from the system",
640
+ "description": "Gets a device count from the system",
641
+ "input": [],
642
+ "output": {
643
+ "name": "result",
644
+ "type": "object",
645
+ "description": "A JSON Object containing status, code and the result",
646
+ "schema": {
647
+ "title": "result",
648
+ "type": "object"
649
+ }
650
+ },
651
+ "roles": [
652
+ "admin"
653
+ ],
654
+ "route": {
655
+ "verb": "POST",
656
+ "path": "/iapGetDeviceCount"
657
+ },
658
+ "task": true
659
+ },
660
+ {
661
+ "name": "getAuditsUsingGET",
662
+ "summary": "This API is used to get audit details for given query param",
663
+ "description": "This API is used to get audit details for given query param",
664
+ "input": [
665
+ {
666
+ "name": "action",
667
+ "type": "array",
668
+ "info": "Available values : USER_ENROLLED, USER_INFO_EDIT, USER_CREATED , USER_DELETED etc.\nPlease refer API Docs for available values.: array",
669
+ "required": false,
670
+ "schema": {
671
+ "title": "action",
672
+ "type": "array"
673
+ }
674
+ },
675
+ {
676
+ "name": "adminRA",
677
+ "type": "array",
678
+ "info": "Administrator userName or RA common name: array",
679
+ "required": false,
680
+ "schema": {
681
+ "title": "adminRA",
682
+ "type": "array"
683
+ }
684
+ },
685
+ {
686
+ "name": "dateFrom",
687
+ "type": "string",
688
+ "info": "Datetime in ISO format: string",
689
+ "required": true,
690
+ "schema": {
691
+ "title": "dateFrom",
692
+ "type": "string"
693
+ }
694
+ },
695
+ {
696
+ "name": "dateTo",
697
+ "type": "string",
698
+ "info": "Datetime in ISO format. Time span from dateFrom cannot exceed 365 days.: string",
699
+ "required": true,
700
+ "schema": {
701
+ "title": "dateTo",
702
+ "type": "string"
703
+ }
704
+ },
705
+ {
706
+ "name": "limit",
707
+ "type": "number",
708
+ "info": "Default Limit is 100: 123",
709
+ "required": false,
710
+ "schema": {
711
+ "title": "limit",
712
+ "type": "number"
713
+ }
714
+ },
715
+ {
716
+ "name": "offset",
717
+ "type": "number",
718
+ "info": "Default value is 0: 123",
719
+ "required": false,
720
+ "schema": {
721
+ "title": "offset",
722
+ "type": "number"
723
+ }
724
+ }
725
+ ],
726
+ "output": {
727
+ "name": "result",
728
+ "type": "object",
729
+ "description": "A JSON Object containing status, code and the result",
730
+ "schema": {
731
+ "title": "result",
732
+ "type": "object"
733
+ }
734
+ },
735
+ "roles": [
736
+ "admin"
737
+ ],
738
+ "route": {
739
+ "verb": "POST",
740
+ "path": "/getAuditsUsingGET"
741
+ },
742
+ "task": true
743
+ },
744
+ {
745
+ "name": "getAuditUsingGET",
746
+ "summary": "This API is used to get audit details for given audit Id.",
747
+ "description": "This API is used to get audit details for given audit Id.",
748
+ "input": [
749
+ {
750
+ "name": "auditId",
751
+ "type": "number",
752
+ "info": "auditId: 123",
753
+ "required": true,
754
+ "schema": {
755
+ "title": "auditId",
756
+ "type": "number"
757
+ }
758
+ }
759
+ ],
760
+ "output": {
761
+ "name": "result",
762
+ "type": "object",
763
+ "description": "A JSON Object containing status, code and the result",
764
+ "schema": {
765
+ "title": "result",
766
+ "type": "object"
767
+ }
768
+ },
769
+ "roles": [
770
+ "admin"
771
+ ],
772
+ "route": {
773
+ "verb": "POST",
774
+ "path": "/getAuditUsingGET"
775
+ },
776
+ "task": true
777
+ },
778
+ {
779
+ "name": "getCAInfoUsingGET",
780
+ "summary": "This API is used to get public CA details for a given ca identifier",
781
+ "description": "This API is used to get public CA details for a given ca identifier",
782
+ "input": [
783
+ {
784
+ "name": "caId",
785
+ "type": "string",
786
+ "info": "caId: string",
787
+ "required": true,
788
+ "schema": {
789
+ "title": "caId",
790
+ "type": "string"
791
+ }
792
+ }
793
+ ],
794
+ "output": {
795
+ "name": "result",
796
+ "type": "object",
797
+ "description": "A JSON Object containing status, code and the result",
798
+ "schema": {
799
+ "title": "result",
800
+ "type": "object"
801
+ }
802
+ },
803
+ "roles": [
804
+ "admin"
805
+ ],
806
+ "route": {
807
+ "verb": "POST",
808
+ "path": "/getCAInfoUsingGET"
809
+ },
810
+ "task": true
811
+ },
812
+ {
813
+ "name": "getCAUsingGET",
814
+ "summary": "This API is used to get public CA details for a given account api key",
815
+ "description": "This API is used to get public CA details for a given account api key",
816
+ "input": [
817
+ {
818
+ "name": "seatType",
819
+ "type": "string",
820
+ "info": "seatType: string",
821
+ "required": true,
822
+ "schema": {
823
+ "title": "seatType",
824
+ "type": "string"
825
+ }
826
+ }
827
+ ],
828
+ "output": {
829
+ "name": "result",
830
+ "type": "object",
831
+ "description": "A JSON Object containing status, code and the result",
832
+ "schema": {
833
+ "title": "result",
834
+ "type": "object"
835
+ }
836
+ },
837
+ "roles": [
838
+ "admin"
839
+ ],
840
+ "route": {
841
+ "verb": "POST",
842
+ "path": "/getCAUsingGET"
843
+ },
844
+ "task": true
845
+ },
846
+ {
847
+ "name": "enrollCertificateUsingPOST",
848
+ "summary": "This API is used to enroll a certificate for a given profile.",
849
+ "description": "This API is used to enroll a certificate for a given profile.",
850
+ "input": [
851
+ {
852
+ "name": "enrollCertificateRequest",
853
+ "type": "object",
854
+ "info": "enrollCertificateRequest: {\"attributes\": {\"common_name\": \"string\", \"content_type\": \"string\", \"counter_signature\": \"string\", \"country\": \"string\", \"custom_attributes\": \"object\", \"dn_qualifier\": \"string\", \"domain_component\": [{\"id\": \"string\", \"mandatory\": \"boolean\", \"type\": \"string\", \"value\": \"string\"}], \"domain_name\": \"string\", \"email\": \"string\", \"given_name\": \"string\", \"ip_address\": \"string\", \"job_title\": \"string\", \"locality\": \"string\", \"message_digest\": \"string\", \"organization_name\": \"string\", \"organization_unit\": [{\"id\": \"string\", \"mandatory\": \"boolean\", \"type\": \"string\", \"value\": \"string\"}], \"postal_code\": \"string\", \"pseudonym\": \"string\", \"san\": {\"custom_attributes\": \"object\", \"directory_name\": \"string\", \"dns_name\": [{\"id\": \"string\", \"mandatory\": \"boolean\", \"type\": \"string\", \"value\": \"string\"}], \"ip_address\": [{\"id\": \"string\", \"mandatory\": \"boolean\", \"type\": \"string\", \"value\": \"string\"}], \"other_name\": [{\"id\": \"string\", \"mandatory\": \"boolean\", \"type\": \"string\", \"value\": \"string\"}], \"registered_id\": [{\"id\": \"string\", \"mandatory\": \"boolean\", \"type\": \"string\", \"value\": \"string\"}], \"rfc822_name\": [{\"id\": \"string\", \"mandatory\": \"boolean\", \"type\": \"string\", \"value\": \"string\"}], \"user_principal_name\": [{\"id\": \"string\", \"mandatory\": \"boolean\", \"type\": \"string\", \"value\": \"string\"}]}, \"serial_number\": \"string\", \"signing_time\": \"string\", \"state\": \"string\", \"street_address\": [{\"id\": \"string\", \"mandatory\": \"boolean\", \"type\": \"string\", \"value\": \"string\"}], \"surname\": \"string\", \"unique_identifier\": \"string\", \"unstructured_address\": \"string\", \"unstructured_name\": \"string\", \"user_id\": \"string\"}, \"authentication\": \"object\", \"csr\": \"string\", \"profile\": {\"id\": \"string\", \"name\": \"string\"}, \"seat\": {\"email\": \"string\", \"seat_id\": \"string\", \"seat_name\": \"string\"}, \"session_key\": \"string\", \"validity\": {\"duration\": 123, \"unit\": \"string\"}}",
855
+ "required": true,
856
+ "schema": {
857
+ "type": "object",
858
+ "properties": {
859
+ "attributes": {
860
+ "type": "object",
861
+ "properties": {
862
+ "common_name": {
863
+ "type": "string"
864
+ },
865
+ "content_type": {
866
+ "type": "string"
867
+ },
868
+ "counter_signature": {
869
+ "type": "string"
870
+ },
871
+ "country": {
872
+ "type": "string"
873
+ },
874
+ "custom_attributes": {
875
+ "type": "object",
876
+ "additionalProperties": {
877
+ "type": "string"
878
+ }
879
+ },
880
+ "dn_qualifier": {
881
+ "type": "string"
882
+ },
883
+ "domain_component": {
884
+ "type": "array",
885
+ "items": {
886
+ "type": "object",
887
+ "properties": {
888
+ "id": {
889
+ "type": "string"
890
+ },
891
+ "mandatory": {
892
+ "type": "boolean"
893
+ },
894
+ "type": {
895
+ "type": "string"
896
+ },
897
+ "value": {
898
+ "type": "string"
899
+ }
900
+ },
901
+ "title": "Attribute"
902
+ }
903
+ },
904
+ "domain_name": {
905
+ "type": "string"
906
+ },
907
+ "email": {
908
+ "type": "string"
909
+ },
910
+ "given_name": {
911
+ "type": "string"
912
+ },
913
+ "ip_address": {
914
+ "type": "string"
915
+ },
916
+ "job_title": {
917
+ "type": "string"
918
+ },
919
+ "locality": {
920
+ "type": "string"
921
+ },
922
+ "message_digest": {
923
+ "type": "string"
924
+ },
925
+ "organization_name": {
926
+ "type": "string"
927
+ },
928
+ "organization_unit": {
929
+ "type": "array",
930
+ "items": {
931
+ "type": "object",
932
+ "properties": {
933
+ "id": {
934
+ "type": "string"
935
+ },
936
+ "mandatory": {
937
+ "type": "boolean"
938
+ },
939
+ "type": {
940
+ "type": "string"
941
+ },
942
+ "value": {
943
+ "type": "string"
944
+ }
945
+ },
946
+ "title": "Attribute"
947
+ }
948
+ },
949
+ "postal_code": {
950
+ "type": "string"
951
+ },
952
+ "pseudonym": {
953
+ "type": "string"
954
+ },
955
+ "san": {
956
+ "type": "object",
957
+ "properties": {
958
+ "custom_attributes": {
959
+ "type": "object",
960
+ "additionalProperties": {
961
+ "type": "string"
962
+ }
963
+ },
964
+ "directory_name": {
965
+ "type": "string"
966
+ },
967
+ "dns_name": {
968
+ "type": "array",
969
+ "items": {
970
+ "type": "object",
971
+ "properties": {
972
+ "id": {
973
+ "type": "string"
974
+ },
975
+ "mandatory": {
976
+ "type": "boolean"
977
+ },
978
+ "type": {
979
+ "type": "string"
980
+ },
981
+ "value": {
982
+ "type": "string"
983
+ }
984
+ },
985
+ "title": "Attribute"
986
+ }
987
+ },
988
+ "ip_address": {
989
+ "type": "array",
990
+ "items": {
991
+ "type": "object",
992
+ "properties": {
993
+ "id": {
994
+ "type": "string"
995
+ },
996
+ "mandatory": {
997
+ "type": "boolean"
998
+ },
999
+ "type": {
1000
+ "type": "string"
1001
+ },
1002
+ "value": {
1003
+ "type": "string"
1004
+ }
1005
+ },
1006
+ "title": "Attribute"
1007
+ }
1008
+ },
1009
+ "other_name": {
1010
+ "type": "array",
1011
+ "items": {
1012
+ "type": "object",
1013
+ "properties": {
1014
+ "id": {
1015
+ "type": "string"
1016
+ },
1017
+ "mandatory": {
1018
+ "type": "boolean"
1019
+ },
1020
+ "type": {
1021
+ "type": "string"
1022
+ },
1023
+ "value": {
1024
+ "type": "string"
1025
+ }
1026
+ },
1027
+ "title": "Attribute"
1028
+ }
1029
+ },
1030
+ "registered_id": {
1031
+ "type": "array",
1032
+ "items": {
1033
+ "type": "object",
1034
+ "properties": {
1035
+ "id": {
1036
+ "type": "string"
1037
+ },
1038
+ "mandatory": {
1039
+ "type": "boolean"
1040
+ },
1041
+ "type": {
1042
+ "type": "string"
1043
+ },
1044
+ "value": {
1045
+ "type": "string"
1046
+ }
1047
+ },
1048
+ "title": "Attribute"
1049
+ }
1050
+ },
1051
+ "rfc822_name": {
1052
+ "type": "array",
1053
+ "items": {
1054
+ "type": "object",
1055
+ "properties": {
1056
+ "id": {
1057
+ "type": "string"
1058
+ },
1059
+ "mandatory": {
1060
+ "type": "boolean"
1061
+ },
1062
+ "type": {
1063
+ "type": "string"
1064
+ },
1065
+ "value": {
1066
+ "type": "string"
1067
+ }
1068
+ },
1069
+ "title": "Attribute"
1070
+ }
1071
+ },
1072
+ "user_principal_name": {
1073
+ "type": "array",
1074
+ "items": {
1075
+ "type": "object",
1076
+ "properties": {
1077
+ "id": {
1078
+ "type": "string"
1079
+ },
1080
+ "mandatory": {
1081
+ "type": "boolean"
1082
+ },
1083
+ "type": {
1084
+ "type": "string"
1085
+ },
1086
+ "value": {
1087
+ "type": "string"
1088
+ }
1089
+ },
1090
+ "title": "Attribute"
1091
+ }
1092
+ }
1093
+ },
1094
+ "title": "SanAttributes"
1095
+ },
1096
+ "serial_number": {
1097
+ "type": "string"
1098
+ },
1099
+ "signing_time": {
1100
+ "type": "string"
1101
+ },
1102
+ "state": {
1103
+ "type": "string"
1104
+ },
1105
+ "street_address": {
1106
+ "type": "array",
1107
+ "items": {
1108
+ "type": "object",
1109
+ "properties": {
1110
+ "id": {
1111
+ "type": "string"
1112
+ },
1113
+ "mandatory": {
1114
+ "type": "boolean"
1115
+ },
1116
+ "type": {
1117
+ "type": "string"
1118
+ },
1119
+ "value": {
1120
+ "type": "string"
1121
+ }
1122
+ },
1123
+ "title": "Attribute"
1124
+ }
1125
+ },
1126
+ "surname": {
1127
+ "type": "string"
1128
+ },
1129
+ "unique_identifier": {
1130
+ "type": "string"
1131
+ },
1132
+ "unstructured_address": {
1133
+ "type": "string"
1134
+ },
1135
+ "unstructured_name": {
1136
+ "type": "string"
1137
+ },
1138
+ "user_id": {
1139
+ "type": "string"
1140
+ }
1141
+ },
1142
+ "title": "CertificateAttributes"
1143
+ },
1144
+ "authentication": {
1145
+ "type": "object",
1146
+ "additionalProperties": {
1147
+ "type": "string"
1148
+ }
1149
+ },
1150
+ "csr": {
1151
+ "type": "string"
1152
+ },
1153
+ "profile": {
1154
+ "type": "object",
1155
+ "properties": {
1156
+ "id": {
1157
+ "type": "string"
1158
+ },
1159
+ "name": {
1160
+ "type": "string"
1161
+ }
1162
+ },
1163
+ "title": "Profile"
1164
+ },
1165
+ "seat": {
1166
+ "type": "object",
1167
+ "properties": {
1168
+ "email": {
1169
+ "type": "string"
1170
+ },
1171
+ "seat_id": {
1172
+ "type": "string"
1173
+ },
1174
+ "seat_name": {
1175
+ "type": "string"
1176
+ }
1177
+ },
1178
+ "title": "Seat"
1179
+ },
1180
+ "session_key": {
1181
+ "type": "string"
1182
+ },
1183
+ "validity": {
1184
+ "type": "object",
1185
+ "properties": {
1186
+ "duration": {
1187
+ "type": "integer"
1188
+ },
1189
+ "unit": {
1190
+ "type": "string"
1191
+ }
1192
+ },
1193
+ "title": "Validity"
1194
+ }
1195
+ },
1196
+ "title": "RequestCertificateRequest",
1197
+ "definitions": {}
1198
+ }
1199
+ }
1200
+ ],
1201
+ "output": {
1202
+ "name": "result",
1203
+ "type": "object",
1204
+ "description": "A JSON Object containing status, code and the result",
1205
+ "schema": {
1206
+ "title": "result",
1207
+ "type": "object"
1208
+ }
1209
+ },
1210
+ "roles": [
1211
+ "admin"
1212
+ ],
1213
+ "route": {
1214
+ "verb": "POST",
1215
+ "path": "/enrollCertificateUsingPOST"
1216
+ },
1217
+ "task": true
1218
+ },
1219
+ {
1220
+ "name": "createCertificateUsingPOST",
1221
+ "summary": "This API is used to enroll a certificate for a given profile.",
1222
+ "description": "This API is used to enroll a certificate for a given profile.",
1223
+ "input": [
1224
+ {
1225
+ "name": "enrollCertificateRequest",
1226
+ "type": "object",
1227
+ "info": "enrollCertificateRequest: {\"csr\": \"string\", \"extensions\": \"object\", \"include_ca_chain\": \"boolean\", \"profile\": {\"id\": \"string\", \"name\": \"string\"}, \"seat\": {\"email\": \"string\", \"seat_id\": \"string\", \"seat_name\": \"string\"}, \"subject\": \"object\", \"validity\": {\"duration\": 123, \"unit\": \"string\"}}",
1228
+ "required": true,
1229
+ "schema": {
1230
+ "type": "object",
1231
+ "properties": {
1232
+ "csr": {
1233
+ "type": "string"
1234
+ },
1235
+ "extensions": {
1236
+ "type": "object"
1237
+ },
1238
+ "include_ca_chain": {
1239
+ "type": "boolean"
1240
+ },
1241
+ "profile": {
1242
+ "type": "object",
1243
+ "properties": {
1244
+ "id": {
1245
+ "type": "string"
1246
+ },
1247
+ "name": {
1248
+ "type": "string"
1249
+ }
1250
+ },
1251
+ "title": "Profile"
1252
+ },
1253
+ "seat": {
1254
+ "type": "object",
1255
+ "properties": {
1256
+ "email": {
1257
+ "type": "string"
1258
+ },
1259
+ "seat_id": {
1260
+ "type": "string"
1261
+ },
1262
+ "seat_name": {
1263
+ "type": "string"
1264
+ }
1265
+ },
1266
+ "title": "Seat"
1267
+ },
1268
+ "subject": {
1269
+ "type": "object"
1270
+ },
1271
+ "validity": {
1272
+ "type": "object",
1273
+ "properties": {
1274
+ "duration": {
1275
+ "type": "integer"
1276
+ },
1277
+ "unit": {
1278
+ "type": "string"
1279
+ }
1280
+ },
1281
+ "title": "Validity"
1282
+ }
1283
+ },
1284
+ "title": "CreateCertificateRequest",
1285
+ "definitions": {}
1286
+ }
1287
+ }
1288
+ ],
1289
+ "output": {
1290
+ "name": "result",
1291
+ "type": "object",
1292
+ "description": "A JSON Object containing status, code and the result",
1293
+ "schema": {
1294
+ "title": "result",
1295
+ "type": "object"
1296
+ }
1297
+ },
1298
+ "roles": [
1299
+ "admin"
1300
+ ],
1301
+ "route": {
1302
+ "verb": "POST",
1303
+ "path": "/createCertificateUsingPOST"
1304
+ },
1305
+ "task": true
1306
+ },
1307
+ {
1308
+ "name": "renewExternalCertificateUsingPOST",
1309
+ "summary": "This API is used to enroll a certificate for a given profile.",
1310
+ "description": "This API is used to enroll a certificate for a given profile.",
1311
+ "input": [
1312
+ {
1313
+ "name": "enrollCertificateRequest",
1314
+ "type": "object",
1315
+ "info": "enrollCertificateRequest: {\"csr\": \"string\", \"extensions\": \"object\", \"include_ca_chain\": \"boolean\", \"profile\": {\"id\": \"string\", \"name\": \"string\"}, \"seat\": {\"email\": \"string\", \"seat_id\": \"string\", \"seat_name\": \"string\"}, \"subject\": \"object\", \"validity\": {\"duration\": 123, \"unit\": \"string\"}}",
1316
+ "required": true,
1317
+ "schema": {
1318
+ "type": "object",
1319
+ "properties": {
1320
+ "csr": {
1321
+ "type": "string"
1322
+ },
1323
+ "extensions": {
1324
+ "type": "object"
1325
+ },
1326
+ "include_ca_chain": {
1327
+ "type": "boolean"
1328
+ },
1329
+ "profile": {
1330
+ "type": "object",
1331
+ "properties": {
1332
+ "id": {
1333
+ "type": "string"
1334
+ },
1335
+ "name": {
1336
+ "type": "string"
1337
+ }
1338
+ },
1339
+ "title": "Profile"
1340
+ },
1341
+ "seat": {
1342
+ "type": "object",
1343
+ "properties": {
1344
+ "email": {
1345
+ "type": "string"
1346
+ },
1347
+ "seat_id": {
1348
+ "type": "string"
1349
+ },
1350
+ "seat_name": {
1351
+ "type": "string"
1352
+ }
1353
+ },
1354
+ "title": "Seat"
1355
+ },
1356
+ "subject": {
1357
+ "type": "object"
1358
+ },
1359
+ "validity": {
1360
+ "type": "object",
1361
+ "properties": {
1362
+ "duration": {
1363
+ "type": "integer"
1364
+ },
1365
+ "unit": {
1366
+ "type": "string"
1367
+ }
1368
+ },
1369
+ "title": "Validity"
1370
+ }
1371
+ },
1372
+ "title": "CreateCertificateRequest",
1373
+ "definitions": {}
1374
+ }
1375
+ },
1376
+ {
1377
+ "name": "serialNumber",
1378
+ "type": "string",
1379
+ "info": "serialNumber: string",
1380
+ "required": true,
1381
+ "schema": {
1382
+ "title": "serialNumber",
1383
+ "type": "string"
1384
+ }
1385
+ }
1386
+ ],
1387
+ "output": {
1388
+ "name": "result",
1389
+ "type": "object",
1390
+ "description": "A JSON Object containing status, code and the result",
1391
+ "schema": {
1392
+ "title": "result",
1393
+ "type": "object"
1394
+ }
1395
+ },
1396
+ "roles": [
1397
+ "admin"
1398
+ ],
1399
+ "route": {
1400
+ "verb": "POST",
1401
+ "path": "/renewExternalCertificateUsingPOST"
1402
+ },
1403
+ "task": true
1404
+ },
1405
+ {
1406
+ "name": "getCertificateUsingGET",
1407
+ "summary": "This API is used to get certificate details for a given certificate serial number",
1408
+ "description": "This API is used to get certificate details for a given certificate serial number",
1409
+ "input": [
1410
+ {
1411
+ "name": "serialNumber",
1412
+ "type": "string",
1413
+ "info": "serialNumber: string",
1414
+ "required": true,
1415
+ "schema": {
1416
+ "title": "serialNumber",
1417
+ "type": "string"
1418
+ }
1419
+ }
1420
+ ],
1421
+ "output": {
1422
+ "name": "result",
1423
+ "type": "object",
1424
+ "description": "A JSON Object containing status, code and the result",
1425
+ "schema": {
1426
+ "title": "result",
1427
+ "type": "object"
1428
+ }
1429
+ },
1430
+ "roles": [
1431
+ "admin"
1432
+ ],
1433
+ "route": {
1434
+ "verb": "POST",
1435
+ "path": "/getCertificateUsingGET"
1436
+ },
1437
+ "task": true
1438
+ },
1439
+ {
1440
+ "name": "recoverKeyUsingGET",
1441
+ "summary": "This API is used to get private key information for key-escrowed certificate with given serial numb",
1442
+ "description": "This API is used to get private key information for key-escrowed certificate with given serial number",
1443
+ "input": [
1444
+ {
1445
+ "name": "serialNumber",
1446
+ "type": "string",
1447
+ "info": "serialNumber: string",
1448
+ "required": true,
1449
+ "schema": {
1450
+ "title": "serialNumber",
1451
+ "type": "string"
1452
+ }
1453
+ }
1454
+ ],
1455
+ "output": {
1456
+ "name": "result",
1457
+ "type": "object",
1458
+ "description": "A JSON Object containing status, code and the result",
1459
+ "schema": {
1460
+ "title": "result",
1461
+ "type": "object"
1462
+ }
1463
+ },
1464
+ "roles": [
1465
+ "admin"
1466
+ ],
1467
+ "route": {
1468
+ "verb": "POST",
1469
+ "path": "/recoverKeyUsingGET"
1470
+ },
1471
+ "task": true
1472
+ },
1473
+ {
1474
+ "name": "renewCertificateUsingPOST",
1475
+ "summary": "This API is used to renew certificate with the given serial number.",
1476
+ "description": "This API is used to renew certificate with the given serial number.",
1477
+ "input": [
1478
+ {
1479
+ "name": "enrollCertificateRequest",
1480
+ "type": "object",
1481
+ "info": "enrollCertificateRequest: {\"attributes\": {\"common_name\": \"string\", \"content_type\": \"string\", \"counter_signature\": \"string\", \"country\": \"string\", \"custom_attributes\": \"object\", \"dn_qualifier\": \"string\", \"domain_component\": [{\"id\": \"string\", \"mandatory\": \"boolean\", \"type\": \"string\", \"value\": \"string\"}], \"domain_name\": \"string\", \"email\": \"string\", \"given_name\": \"string\", \"ip_address\": \"string\", \"job_title\": \"string\", \"locality\": \"string\", \"message_digest\": \"string\", \"organization_name\": \"string\", \"organization_unit\": [{\"id\": \"string\", \"mandatory\": \"boolean\", \"type\": \"string\", \"value\": \"string\"}], \"postal_code\": \"string\", \"pseudonym\": \"string\", \"san\": {\"custom_attributes\": \"object\", \"directory_name\": \"string\", \"dns_name\": [{\"id\": \"string\", \"mandatory\": \"boolean\", \"type\": \"string\", \"value\": \"string\"}], \"ip_address\": [{\"id\": \"string\", \"mandatory\": \"boolean\", \"type\": \"string\", \"value\": \"string\"}], \"other_name\": [{\"id\": \"string\", \"mandatory\": \"boolean\", \"type\": \"string\", \"value\": \"string\"}], \"registered_id\": [{\"id\": \"string\", \"mandatory\": \"boolean\", \"type\": \"string\", \"value\": \"string\"}], \"rfc822_name\": [{\"id\": \"string\", \"mandatory\": \"boolean\", \"type\": \"string\", \"value\": \"string\"}], \"user_principal_name\": [{\"id\": \"string\", \"mandatory\": \"boolean\", \"type\": \"string\", \"value\": \"string\"}]}, \"serial_number\": \"string\", \"signing_time\": \"string\", \"state\": \"string\", \"street_address\": [{\"id\": \"string\", \"mandatory\": \"boolean\", \"type\": \"string\", \"value\": \"string\"}], \"surname\": \"string\", \"unique_identifier\": \"string\", \"unstructured_address\": \"string\", \"unstructured_name\": \"string\", \"user_id\": \"string\"}, \"authentication\": \"object\", \"csr\": \"string\", \"profile\": {\"id\": \"string\", \"name\": \"string\"}, \"seat\": {\"email\": \"string\", \"seat_id\": \"string\", \"seat_name\": \"string\"}, \"session_key\": \"string\", \"validity\": {\"duration\": 123, \"unit\": \"string\"}}",
1482
+ "required": true,
1483
+ "schema": {
1484
+ "type": "object",
1485
+ "properties": {
1486
+ "attributes": {
1487
+ "type": "object",
1488
+ "properties": {
1489
+ "common_name": {
1490
+ "type": "string"
1491
+ },
1492
+ "content_type": {
1493
+ "type": "string"
1494
+ },
1495
+ "counter_signature": {
1496
+ "type": "string"
1497
+ },
1498
+ "country": {
1499
+ "type": "string"
1500
+ },
1501
+ "custom_attributes": {
1502
+ "type": "object",
1503
+ "additionalProperties": {
1504
+ "type": "string"
1505
+ }
1506
+ },
1507
+ "dn_qualifier": {
1508
+ "type": "string"
1509
+ },
1510
+ "domain_component": {
1511
+ "type": "array",
1512
+ "items": {
1513
+ "type": "object",
1514
+ "properties": {
1515
+ "id": {
1516
+ "type": "string"
1517
+ },
1518
+ "mandatory": {
1519
+ "type": "boolean"
1520
+ },
1521
+ "type": {
1522
+ "type": "string"
1523
+ },
1524
+ "value": {
1525
+ "type": "string"
1526
+ }
1527
+ },
1528
+ "title": "Attribute"
1529
+ }
1530
+ },
1531
+ "domain_name": {
1532
+ "type": "string"
1533
+ },
1534
+ "email": {
1535
+ "type": "string"
1536
+ },
1537
+ "given_name": {
1538
+ "type": "string"
1539
+ },
1540
+ "ip_address": {
1541
+ "type": "string"
1542
+ },
1543
+ "job_title": {
1544
+ "type": "string"
1545
+ },
1546
+ "locality": {
1547
+ "type": "string"
1548
+ },
1549
+ "message_digest": {
1550
+ "type": "string"
1551
+ },
1552
+ "organization_name": {
1553
+ "type": "string"
1554
+ },
1555
+ "organization_unit": {
1556
+ "type": "array",
1557
+ "items": {
1558
+ "type": "object",
1559
+ "properties": {
1560
+ "id": {
1561
+ "type": "string"
1562
+ },
1563
+ "mandatory": {
1564
+ "type": "boolean"
1565
+ },
1566
+ "type": {
1567
+ "type": "string"
1568
+ },
1569
+ "value": {
1570
+ "type": "string"
1571
+ }
1572
+ },
1573
+ "title": "Attribute"
1574
+ }
1575
+ },
1576
+ "postal_code": {
1577
+ "type": "string"
1578
+ },
1579
+ "pseudonym": {
1580
+ "type": "string"
1581
+ },
1582
+ "san": {
1583
+ "type": "object",
1584
+ "properties": {
1585
+ "custom_attributes": {
1586
+ "type": "object",
1587
+ "additionalProperties": {
1588
+ "type": "string"
1589
+ }
1590
+ },
1591
+ "directory_name": {
1592
+ "type": "string"
1593
+ },
1594
+ "dns_name": {
1595
+ "type": "array",
1596
+ "items": {
1597
+ "type": "object",
1598
+ "properties": {
1599
+ "id": {
1600
+ "type": "string"
1601
+ },
1602
+ "mandatory": {
1603
+ "type": "boolean"
1604
+ },
1605
+ "type": {
1606
+ "type": "string"
1607
+ },
1608
+ "value": {
1609
+ "type": "string"
1610
+ }
1611
+ },
1612
+ "title": "Attribute"
1613
+ }
1614
+ },
1615
+ "ip_address": {
1616
+ "type": "array",
1617
+ "items": {
1618
+ "type": "object",
1619
+ "properties": {
1620
+ "id": {
1621
+ "type": "string"
1622
+ },
1623
+ "mandatory": {
1624
+ "type": "boolean"
1625
+ },
1626
+ "type": {
1627
+ "type": "string"
1628
+ },
1629
+ "value": {
1630
+ "type": "string"
1631
+ }
1632
+ },
1633
+ "title": "Attribute"
1634
+ }
1635
+ },
1636
+ "other_name": {
1637
+ "type": "array",
1638
+ "items": {
1639
+ "type": "object",
1640
+ "properties": {
1641
+ "id": {
1642
+ "type": "string"
1643
+ },
1644
+ "mandatory": {
1645
+ "type": "boolean"
1646
+ },
1647
+ "type": {
1648
+ "type": "string"
1649
+ },
1650
+ "value": {
1651
+ "type": "string"
1652
+ }
1653
+ },
1654
+ "title": "Attribute"
1655
+ }
1656
+ },
1657
+ "registered_id": {
1658
+ "type": "array",
1659
+ "items": {
1660
+ "type": "object",
1661
+ "properties": {
1662
+ "id": {
1663
+ "type": "string"
1664
+ },
1665
+ "mandatory": {
1666
+ "type": "boolean"
1667
+ },
1668
+ "type": {
1669
+ "type": "string"
1670
+ },
1671
+ "value": {
1672
+ "type": "string"
1673
+ }
1674
+ },
1675
+ "title": "Attribute"
1676
+ }
1677
+ },
1678
+ "rfc822_name": {
1679
+ "type": "array",
1680
+ "items": {
1681
+ "type": "object",
1682
+ "properties": {
1683
+ "id": {
1684
+ "type": "string"
1685
+ },
1686
+ "mandatory": {
1687
+ "type": "boolean"
1688
+ },
1689
+ "type": {
1690
+ "type": "string"
1691
+ },
1692
+ "value": {
1693
+ "type": "string"
1694
+ }
1695
+ },
1696
+ "title": "Attribute"
1697
+ }
1698
+ },
1699
+ "user_principal_name": {
1700
+ "type": "array",
1701
+ "items": {
1702
+ "type": "object",
1703
+ "properties": {
1704
+ "id": {
1705
+ "type": "string"
1706
+ },
1707
+ "mandatory": {
1708
+ "type": "boolean"
1709
+ },
1710
+ "type": {
1711
+ "type": "string"
1712
+ },
1713
+ "value": {
1714
+ "type": "string"
1715
+ }
1716
+ },
1717
+ "title": "Attribute"
1718
+ }
1719
+ }
1720
+ },
1721
+ "title": "SanAttributes"
1722
+ },
1723
+ "serial_number": {
1724
+ "type": "string"
1725
+ },
1726
+ "signing_time": {
1727
+ "type": "string"
1728
+ },
1729
+ "state": {
1730
+ "type": "string"
1731
+ },
1732
+ "street_address": {
1733
+ "type": "array",
1734
+ "items": {
1735
+ "type": "object",
1736
+ "properties": {
1737
+ "id": {
1738
+ "type": "string"
1739
+ },
1740
+ "mandatory": {
1741
+ "type": "boolean"
1742
+ },
1743
+ "type": {
1744
+ "type": "string"
1745
+ },
1746
+ "value": {
1747
+ "type": "string"
1748
+ }
1749
+ },
1750
+ "title": "Attribute"
1751
+ }
1752
+ },
1753
+ "surname": {
1754
+ "type": "string"
1755
+ },
1756
+ "unique_identifier": {
1757
+ "type": "string"
1758
+ },
1759
+ "unstructured_address": {
1760
+ "type": "string"
1761
+ },
1762
+ "unstructured_name": {
1763
+ "type": "string"
1764
+ },
1765
+ "user_id": {
1766
+ "type": "string"
1767
+ }
1768
+ },
1769
+ "title": "CertificateAttributes"
1770
+ },
1771
+ "authentication": {
1772
+ "type": "object",
1773
+ "additionalProperties": {
1774
+ "type": "string"
1775
+ }
1776
+ },
1777
+ "csr": {
1778
+ "type": "string"
1779
+ },
1780
+ "profile": {
1781
+ "type": "object",
1782
+ "properties": {
1783
+ "id": {
1784
+ "type": "string"
1785
+ },
1786
+ "name": {
1787
+ "type": "string"
1788
+ }
1789
+ },
1790
+ "title": "Profile"
1791
+ },
1792
+ "seat": {
1793
+ "type": "object",
1794
+ "properties": {
1795
+ "email": {
1796
+ "type": "string"
1797
+ },
1798
+ "seat_id": {
1799
+ "type": "string"
1800
+ },
1801
+ "seat_name": {
1802
+ "type": "string"
1803
+ }
1804
+ },
1805
+ "title": "Seat"
1806
+ },
1807
+ "session_key": {
1808
+ "type": "string"
1809
+ },
1810
+ "validity": {
1811
+ "type": "object",
1812
+ "properties": {
1813
+ "duration": {
1814
+ "type": "integer"
1815
+ },
1816
+ "unit": {
1817
+ "type": "string"
1818
+ }
1819
+ },
1820
+ "title": "Validity"
1821
+ }
1822
+ },
1823
+ "title": "RequestCertificateRequest",
1824
+ "definitions": {}
1825
+ }
1826
+ },
1827
+ {
1828
+ "name": "serialNumber",
1829
+ "type": "string",
1830
+ "info": "serialNumber: string",
1831
+ "required": true,
1832
+ "schema": {
1833
+ "title": "serialNumber",
1834
+ "type": "string"
1835
+ }
1836
+ }
1837
+ ],
1838
+ "output": {
1839
+ "name": "result",
1840
+ "type": "object",
1841
+ "description": "A JSON Object containing status, code and the result",
1842
+ "schema": {
1843
+ "title": "result",
1844
+ "type": "object"
1845
+ }
1846
+ },
1847
+ "roles": [
1848
+ "admin"
1849
+ ],
1850
+ "route": {
1851
+ "verb": "POST",
1852
+ "path": "/renewCertificateUsingPOST"
1853
+ },
1854
+ "task": true
1855
+ },
1856
+ {
1857
+ "name": "revokeCertificateUsingPUT",
1858
+ "summary": "This API can revoke certificate with the given serial number",
1859
+ "description": "This API can revoke certificate with the given serial number",
1860
+ "input": [
1861
+ {
1862
+ "name": "revokeCertificateRequest",
1863
+ "type": "object",
1864
+ "info": "revokeCertificateRequest: {\"revocation_reason\": \"string\"}",
1865
+ "required": false,
1866
+ "schema": {
1867
+ "type": "object",
1868
+ "properties": {
1869
+ "revocation_reason": {
1870
+ "type": "string"
1871
+ }
1872
+ },
1873
+ "title": "RevokeCertificateRequest",
1874
+ "definitions": {}
1875
+ }
1876
+ },
1877
+ {
1878
+ "name": "serialNumber",
1879
+ "type": "string",
1880
+ "info": "serialNumber: string",
1881
+ "required": true,
1882
+ "schema": {
1883
+ "title": "serialNumber",
1884
+ "type": "string"
1885
+ }
1886
+ }
1887
+ ],
1888
+ "output": {
1889
+ "name": "result",
1890
+ "type": "object",
1891
+ "description": "A JSON Object containing status, code and the result",
1892
+ "schema": {
1893
+ "title": "result",
1894
+ "type": "object"
1895
+ }
1896
+ },
1897
+ "roles": [
1898
+ "admin"
1899
+ ],
1900
+ "route": {
1901
+ "verb": "POST",
1902
+ "path": "/revokeCertificateUsingPUT"
1903
+ },
1904
+ "task": true
1905
+ },
1906
+ {
1907
+ "name": "unRevokeCertificateUsingDELETE",
1908
+ "summary": "This API can resume certificate with the given serial number.",
1909
+ "description": "This API can resume certificate with the given serial number.",
1910
+ "input": [
1911
+ {
1912
+ "name": "serialNumber",
1913
+ "type": "string",
1914
+ "info": "serialNumber: string",
1915
+ "required": true,
1916
+ "schema": {
1917
+ "title": "serialNumber",
1918
+ "type": "string"
1919
+ }
1920
+ }
1921
+ ],
1922
+ "output": {
1923
+ "name": "result",
1924
+ "type": "object",
1925
+ "description": "A JSON Object containing status, code and the result",
1926
+ "schema": {
1927
+ "title": "result",
1928
+ "type": "object"
1929
+ }
1930
+ },
1931
+ "roles": [
1932
+ "admin"
1933
+ ],
1934
+ "route": {
1935
+ "verb": "POST",
1936
+ "path": "/unRevokeCertificateUsingDELETE"
1937
+ },
1938
+ "task": true
1939
+ },
1940
+ {
1941
+ "name": "createPasscodeUsingPOST",
1942
+ "summary": "This API is used to enroll user for profile.",
1943
+ "description": "This API is used to enroll user for profile.",
1944
+ "input": [
1945
+ {
1946
+ "name": "createPasscodeRequest",
1947
+ "type": "object",
1948
+ "info": "createPasscodeRequest: {\"attributes\": {\"common_name\": \"string\", \"content_type\": \"string\", \"counter_signature\": \"string\", \"country\": \"string\", \"custom_attributes\": \"object\", \"dn_qualifier\": \"string\", \"domain_component\": [{\"id\": \"string\", \"mandatory\": \"boolean\", \"type\": \"string\", \"value\": \"string\"}], \"domain_name\": \"string\", \"email\": \"string\", \"given_name\": \"string\", \"ip_address\": \"string\", \"job_title\": \"string\", \"locality\": \"string\", \"message_digest\": \"string\", \"organization_name\": \"string\", \"organization_unit\": [{\"id\": \"string\", \"mandatory\": \"boolean\", \"type\": \"string\", \"value\": \"string\"}], \"postal_code\": \"string\", \"pseudonym\": \"string\", \"san\": {\"custom_attributes\": \"object\", \"directory_name\": \"string\", \"dns_name\": [{\"id\": \"string\", \"mandatory\": \"boolean\", \"type\": \"string\", \"value\": \"string\"}], \"ip_address\": [{\"id\": \"string\", \"mandatory\": \"boolean\", \"type\": \"string\", \"value\": \"string\"}], \"other_name\": [{\"id\": \"string\", \"mandatory\": \"boolean\", \"type\": \"string\", \"value\": \"string\"}], \"registered_id\": [{\"id\": \"string\", \"mandatory\": \"boolean\", \"type\": \"string\", \"value\": \"string\"}], \"rfc822_name\": [{\"id\": \"string\", \"mandatory\": \"boolean\", \"type\": \"string\", \"value\": \"string\"}], \"user_principal_name\": [{\"id\": \"string\", \"mandatory\": \"boolean\", \"type\": \"string\", \"value\": \"string\"}]}, \"serial_number\": \"string\", \"signing_time\": \"string\", \"state\": \"string\", \"street_address\": [{\"id\": \"string\", \"mandatory\": \"boolean\", \"type\": \"string\", \"value\": \"string\"}], \"surname\": \"string\", \"unique_identifier\": \"string\", \"unstructured_address\": \"string\", \"unstructured_name\": \"string\", \"user_id\": \"string\"}, \"profile\": {\"id\": \"string\", \"name\": \"string\"}, \"seat\": {\"email\": \"string\", \"seat_id\": \"string\", \"seat_name\": \"string\"}}",
1949
+ "required": true,
1950
+ "schema": {
1951
+ "type": "object",
1952
+ "properties": {
1953
+ "attributes": {
1954
+ "type": "object",
1955
+ "properties": {
1956
+ "common_name": {
1957
+ "type": "string"
1958
+ },
1959
+ "content_type": {
1960
+ "type": "string"
1961
+ },
1962
+ "counter_signature": {
1963
+ "type": "string"
1964
+ },
1965
+ "country": {
1966
+ "type": "string"
1967
+ },
1968
+ "custom_attributes": {
1969
+ "type": "object",
1970
+ "additionalProperties": {
1971
+ "type": "string"
1972
+ }
1973
+ },
1974
+ "dn_qualifier": {
1975
+ "type": "string"
1976
+ },
1977
+ "domain_component": {
1978
+ "type": "array",
1979
+ "items": {
1980
+ "type": "object",
1981
+ "properties": {
1982
+ "id": {
1983
+ "type": "string"
1984
+ },
1985
+ "mandatory": {
1986
+ "type": "boolean"
1987
+ },
1988
+ "type": {
1989
+ "type": "string"
1990
+ },
1991
+ "value": {
1992
+ "type": "string"
1993
+ }
1994
+ },
1995
+ "title": "Attribute"
1996
+ }
1997
+ },
1998
+ "domain_name": {
1999
+ "type": "string"
2000
+ },
2001
+ "email": {
2002
+ "type": "string"
2003
+ },
2004
+ "given_name": {
2005
+ "type": "string"
2006
+ },
2007
+ "ip_address": {
2008
+ "type": "string"
2009
+ },
2010
+ "job_title": {
2011
+ "type": "string"
2012
+ },
2013
+ "locality": {
2014
+ "type": "string"
2015
+ },
2016
+ "message_digest": {
2017
+ "type": "string"
2018
+ },
2019
+ "organization_name": {
2020
+ "type": "string"
2021
+ },
2022
+ "organization_unit": {
2023
+ "type": "array",
2024
+ "items": {
2025
+ "type": "object",
2026
+ "properties": {
2027
+ "id": {
2028
+ "type": "string"
2029
+ },
2030
+ "mandatory": {
2031
+ "type": "boolean"
2032
+ },
2033
+ "type": {
2034
+ "type": "string"
2035
+ },
2036
+ "value": {
2037
+ "type": "string"
2038
+ }
2039
+ },
2040
+ "title": "Attribute"
2041
+ }
2042
+ },
2043
+ "postal_code": {
2044
+ "type": "string"
2045
+ },
2046
+ "pseudonym": {
2047
+ "type": "string"
2048
+ },
2049
+ "san": {
2050
+ "type": "object",
2051
+ "properties": {
2052
+ "custom_attributes": {
2053
+ "type": "object",
2054
+ "additionalProperties": {
2055
+ "type": "string"
2056
+ }
2057
+ },
2058
+ "directory_name": {
2059
+ "type": "string"
2060
+ },
2061
+ "dns_name": {
2062
+ "type": "array",
2063
+ "items": {
2064
+ "type": "object",
2065
+ "properties": {
2066
+ "id": {
2067
+ "type": "string"
2068
+ },
2069
+ "mandatory": {
2070
+ "type": "boolean"
2071
+ },
2072
+ "type": {
2073
+ "type": "string"
2074
+ },
2075
+ "value": {
2076
+ "type": "string"
2077
+ }
2078
+ },
2079
+ "title": "Attribute"
2080
+ }
2081
+ },
2082
+ "ip_address": {
2083
+ "type": "array",
2084
+ "items": {
2085
+ "type": "object",
2086
+ "properties": {
2087
+ "id": {
2088
+ "type": "string"
2089
+ },
2090
+ "mandatory": {
2091
+ "type": "boolean"
2092
+ },
2093
+ "type": {
2094
+ "type": "string"
2095
+ },
2096
+ "value": {
2097
+ "type": "string"
2098
+ }
2099
+ },
2100
+ "title": "Attribute"
2101
+ }
2102
+ },
2103
+ "other_name": {
2104
+ "type": "array",
2105
+ "items": {
2106
+ "type": "object",
2107
+ "properties": {
2108
+ "id": {
2109
+ "type": "string"
2110
+ },
2111
+ "mandatory": {
2112
+ "type": "boolean"
2113
+ },
2114
+ "type": {
2115
+ "type": "string"
2116
+ },
2117
+ "value": {
2118
+ "type": "string"
2119
+ }
2120
+ },
2121
+ "title": "Attribute"
2122
+ }
2123
+ },
2124
+ "registered_id": {
2125
+ "type": "array",
2126
+ "items": {
2127
+ "type": "object",
2128
+ "properties": {
2129
+ "id": {
2130
+ "type": "string"
2131
+ },
2132
+ "mandatory": {
2133
+ "type": "boolean"
2134
+ },
2135
+ "type": {
2136
+ "type": "string"
2137
+ },
2138
+ "value": {
2139
+ "type": "string"
2140
+ }
2141
+ },
2142
+ "title": "Attribute"
2143
+ }
2144
+ },
2145
+ "rfc822_name": {
2146
+ "type": "array",
2147
+ "items": {
2148
+ "type": "object",
2149
+ "properties": {
2150
+ "id": {
2151
+ "type": "string"
2152
+ },
2153
+ "mandatory": {
2154
+ "type": "boolean"
2155
+ },
2156
+ "type": {
2157
+ "type": "string"
2158
+ },
2159
+ "value": {
2160
+ "type": "string"
2161
+ }
2162
+ },
2163
+ "title": "Attribute"
2164
+ }
2165
+ },
2166
+ "user_principal_name": {
2167
+ "type": "array",
2168
+ "items": {
2169
+ "type": "object",
2170
+ "properties": {
2171
+ "id": {
2172
+ "type": "string"
2173
+ },
2174
+ "mandatory": {
2175
+ "type": "boolean"
2176
+ },
2177
+ "type": {
2178
+ "type": "string"
2179
+ },
2180
+ "value": {
2181
+ "type": "string"
2182
+ }
2183
+ },
2184
+ "title": "Attribute"
2185
+ }
2186
+ }
2187
+ },
2188
+ "title": "SanAttributes"
2189
+ },
2190
+ "serial_number": {
2191
+ "type": "string"
2192
+ },
2193
+ "signing_time": {
2194
+ "type": "string"
2195
+ },
2196
+ "state": {
2197
+ "type": "string"
2198
+ },
2199
+ "street_address": {
2200
+ "type": "array",
2201
+ "items": {
2202
+ "type": "object",
2203
+ "properties": {
2204
+ "id": {
2205
+ "type": "string"
2206
+ },
2207
+ "mandatory": {
2208
+ "type": "boolean"
2209
+ },
2210
+ "type": {
2211
+ "type": "string"
2212
+ },
2213
+ "value": {
2214
+ "type": "string"
2215
+ }
2216
+ },
2217
+ "title": "Attribute"
2218
+ }
2219
+ },
2220
+ "surname": {
2221
+ "type": "string"
2222
+ },
2223
+ "unique_identifier": {
2224
+ "type": "string"
2225
+ },
2226
+ "unstructured_address": {
2227
+ "type": "string"
2228
+ },
2229
+ "unstructured_name": {
2230
+ "type": "string"
2231
+ },
2232
+ "user_id": {
2233
+ "type": "string"
2234
+ }
2235
+ },
2236
+ "title": "CertificateAttributes"
2237
+ },
2238
+ "profile": {
2239
+ "type": "object",
2240
+ "properties": {
2241
+ "id": {
2242
+ "type": "string"
2243
+ },
2244
+ "name": {
2245
+ "type": "string"
2246
+ }
2247
+ },
2248
+ "title": "Profile"
2249
+ },
2250
+ "seat": {
2251
+ "type": "object",
2252
+ "properties": {
2253
+ "email": {
2254
+ "type": "string"
2255
+ },
2256
+ "seat_id": {
2257
+ "type": "string"
2258
+ },
2259
+ "seat_name": {
2260
+ "type": "string"
2261
+ }
2262
+ },
2263
+ "title": "Seat"
2264
+ }
2265
+ },
2266
+ "title": "CreatePasscodeRequest",
2267
+ "definitions": {}
2268
+ }
2269
+ }
2270
+ ],
2271
+ "output": {
2272
+ "name": "result",
2273
+ "type": "object",
2274
+ "description": "A JSON Object containing status, code and the result",
2275
+ "schema": {
2276
+ "title": "result",
2277
+ "type": "object"
2278
+ }
2279
+ },
2280
+ "roles": [
2281
+ "admin"
2282
+ ],
2283
+ "route": {
2284
+ "verb": "POST",
2285
+ "path": "/createPasscodeUsingPOST"
2286
+ },
2287
+ "task": true
2288
+ },
2289
+ {
2290
+ "name": "getEnrollmentUsingGET",
2291
+ "summary": "This API is used to get details of an existing enrollment.",
2292
+ "description": "This API is used to get details of an existing enrollment.",
2293
+ "input": [
2294
+ {
2295
+ "name": "enrollCode",
2296
+ "type": "string",
2297
+ "info": "enrollCode: string",
2298
+ "required": true,
2299
+ "schema": {
2300
+ "title": "enrollCode",
2301
+ "type": "string"
2302
+ }
2303
+ },
2304
+ {
2305
+ "name": "seatId",
2306
+ "type": "string",
2307
+ "info": "seat_id: string",
2308
+ "required": true,
2309
+ "schema": {
2310
+ "title": "seatId",
2311
+ "type": "string"
2312
+ }
2313
+ }
2314
+ ],
2315
+ "output": {
2316
+ "name": "result",
2317
+ "type": "object",
2318
+ "description": "A JSON Object containing status, code and the result",
2319
+ "schema": {
2320
+ "title": "result",
2321
+ "type": "object"
2322
+ }
2323
+ },
2324
+ "roles": [
2325
+ "admin"
2326
+ ],
2327
+ "route": {
2328
+ "verb": "POST",
2329
+ "path": "/getEnrollmentUsingGET"
2330
+ },
2331
+ "task": true
2332
+ },
2333
+ {
2334
+ "name": "resetPasscodeUsingPUT",
2335
+ "summary": "This API is used to reset enrollment code.",
2336
+ "description": "This API is used to reset enrollment code.",
2337
+ "input": [
2338
+ {
2339
+ "name": "enrollCode",
2340
+ "type": "string",
2341
+ "info": "enrollCode: string",
2342
+ "required": true,
2343
+ "schema": {
2344
+ "title": "enrollCode",
2345
+ "type": "string"
2346
+ }
2347
+ },
2348
+ {
2349
+ "name": "resetPasscodeRequest",
2350
+ "type": "object",
2351
+ "info": "resetPasscodeRequest: {\"seat\": {\"email\": \"string\", \"seat_id\": \"string\", \"seat_name\": \"string\"}}",
2352
+ "required": true,
2353
+ "schema": {
2354
+ "type": "object",
2355
+ "properties": {
2356
+ "seat": {
2357
+ "type": "object",
2358
+ "properties": {
2359
+ "email": {
2360
+ "type": "string"
2361
+ },
2362
+ "seat_id": {
2363
+ "type": "string"
2364
+ },
2365
+ "seat_name": {
2366
+ "type": "string"
2367
+ }
2368
+ },
2369
+ "title": "Seat"
2370
+ }
2371
+ },
2372
+ "title": "ResetPasscodeRequest",
2373
+ "definitions": {}
2374
+ }
2375
+ }
2376
+ ],
2377
+ "output": {
2378
+ "name": "result",
2379
+ "type": "object",
2380
+ "description": "A JSON Object containing status, code and the result",
2381
+ "schema": {
2382
+ "title": "result",
2383
+ "type": "object"
2384
+ }
2385
+ },
2386
+ "roles": [
2387
+ "admin"
2388
+ ],
2389
+ "route": {
2390
+ "verb": "POST",
2391
+ "path": "/resetPasscodeUsingPUT"
2392
+ },
2393
+ "task": true
2394
+ },
2395
+ {
2396
+ "name": "deleteEnrollmentUsingDELETE",
2397
+ "summary": "This API can delete an enrollment for given enrollment id",
2398
+ "description": "This API can delete an enrollment for given enrollment id",
2399
+ "input": [
2400
+ {
2401
+ "name": "deleteEnrollRequest",
2402
+ "type": "object",
2403
+ "info": "deleteEnrollRequest: {\"seat\": {\"email\": \"string\", \"seat_id\": \"string\", \"seat_name\": \"string\"}}",
2404
+ "required": true,
2405
+ "schema": {
2406
+ "type": "object",
2407
+ "properties": {
2408
+ "seat": {
2409
+ "type": "object",
2410
+ "properties": {
2411
+ "email": {
2412
+ "type": "string"
2413
+ },
2414
+ "seat_id": {
2415
+ "type": "string"
2416
+ },
2417
+ "seat_name": {
2418
+ "type": "string"
2419
+ }
2420
+ },
2421
+ "title": "Seat"
2422
+ }
2423
+ },
2424
+ "title": "DeleteEnrollmentRequest",
2425
+ "definitions": {}
2426
+ }
2427
+ },
2428
+ {
2429
+ "name": "enrollCode",
2430
+ "type": "string",
2431
+ "info": "enrollCode: string",
2432
+ "required": true,
2433
+ "schema": {
2434
+ "title": "enrollCode",
2435
+ "type": "string"
2436
+ }
2437
+ }
2438
+ ],
2439
+ "output": {
2440
+ "name": "result",
2441
+ "type": "object",
2442
+ "description": "A JSON Object containing status, code and the result",
2443
+ "schema": {
2444
+ "title": "result",
2445
+ "type": "object"
2446
+ }
2447
+ },
2448
+ "roles": [
2449
+ "admin"
2450
+ ],
2451
+ "route": {
2452
+ "verb": "POST",
2453
+ "path": "/deleteEnrollmentUsingDELETE"
2454
+ },
2455
+ "task": true
2456
+ },
2457
+ {
2458
+ "name": "enrollStatusUsingGET",
2459
+ "summary": "This API is used to get certificate enrollment status.",
2460
+ "description": "This API is used to get certificate enrollment status.",
2461
+ "input": [
2462
+ {
2463
+ "name": "profileId",
2464
+ "type": "string",
2465
+ "info": "profile_id: string",
2466
+ "required": false,
2467
+ "schema": {
2468
+ "title": "profileId",
2469
+ "type": "string"
2470
+ }
2471
+ },
2472
+ {
2473
+ "name": "seatId",
2474
+ "type": "string",
2475
+ "info": "seatId: string",
2476
+ "required": true,
2477
+ "schema": {
2478
+ "title": "seatId",
2479
+ "type": "string"
2480
+ }
2481
+ }
2482
+ ],
2483
+ "output": {
2484
+ "name": "result",
2485
+ "type": "object",
2486
+ "description": "A JSON Object containing status, code and the result",
2487
+ "schema": {
2488
+ "type": "array",
2489
+ "items": {
2490
+ "type": "object",
2491
+ "properties": {
2492
+ "certificates": {
2493
+ "type": "array",
2494
+ "items": {
2495
+ "type": "string"
2496
+ }
2497
+ },
2498
+ "created_at": {
2499
+ "type": "string"
2500
+ },
2501
+ "profile_id": {
2502
+ "type": "string"
2503
+ },
2504
+ "status": {
2505
+ "type": "string"
2506
+ },
2507
+ "updated_at": {
2508
+ "type": "string"
2509
+ }
2510
+ },
2511
+ "title": "GetEnrollStatusResponse"
2512
+ }
2513
+ }
2514
+ },
2515
+ "roles": [
2516
+ "admin"
2517
+ ],
2518
+ "route": {
2519
+ "verb": "POST",
2520
+ "path": "/enrollStatusUsingGET"
2521
+ },
2522
+ "task": true
2523
+ },
2524
+ {
2525
+ "name": "helloUsingGET",
2526
+ "summary": "Hello API",
2527
+ "description": "Hello API",
2528
+ "input": [],
2529
+ "output": {
2530
+ "name": "result",
2531
+ "type": "object",
2532
+ "description": "A JSON Object containing status, code and the result",
2533
+ "schema": {
2534
+ "title": "result",
2535
+ "type": "object"
2536
+ }
2537
+ },
2538
+ "roles": [
2539
+ "admin"
2540
+ ],
2541
+ "route": {
2542
+ "verb": "GET",
2543
+ "path": "/helloUsingGET"
2544
+ },
2545
+ "task": true
2546
+ },
2547
+ {
2548
+ "name": "getAllProfilesUsingGET",
2549
+ "summary": "This API is used to get profile details of all profiles in an account and its subaccounts",
2550
+ "description": "This API is used to get profile details of all profiles in an account and its subaccounts",
2551
+ "input": [],
2552
+ "output": {
2553
+ "name": "result",
2554
+ "type": "object",
2555
+ "description": "A JSON Object containing status, code and the result",
2556
+ "schema": {
2557
+ "type": "array",
2558
+ "items": {
2559
+ "type": "object",
2560
+ "properties": {
2561
+ "authentication": {
2562
+ "type": "object",
2563
+ "properties": {
2564
+ "approval": {
2565
+ "type": "string"
2566
+ },
2567
+ "attributes": {
2568
+ "type": "array",
2569
+ "items": {
2570
+ "type": "object",
2571
+ "properties": {
2572
+ "display_name": {
2573
+ "type": "string"
2574
+ },
2575
+ "id": {
2576
+ "type": "string"
2577
+ },
2578
+ "mandatory": {
2579
+ "type": "boolean"
2580
+ },
2581
+ "type": {
2582
+ "type": "string"
2583
+ },
2584
+ "value": {
2585
+ "type": "string"
2586
+ }
2587
+ },
2588
+ "title": "AuthAttribute"
2589
+ }
2590
+ },
2591
+ "method": {
2592
+ "type": "string"
2593
+ },
2594
+ "method_id": {
2595
+ "type": "string"
2596
+ }
2597
+ },
2598
+ "title": "Authentication"
2599
+ },
2600
+ "certificate": {
2601
+ "type": "object",
2602
+ "properties": {
2603
+ "extensions": {
2604
+ "type": "object",
2605
+ "properties": {
2606
+ "san": {
2607
+ "type": "object",
2608
+ "properties": {
2609
+ "attributes": {
2610
+ "type": "array",
2611
+ "items": {
2612
+ "type": "object",
2613
+ "properties": {
2614
+ "id": {
2615
+ "type": "string"
2616
+ },
2617
+ "mandatory": {
2618
+ "type": "boolean"
2619
+ },
2620
+ "type": {
2621
+ "type": "string"
2622
+ },
2623
+ "value": {
2624
+ "type": "string"
2625
+ }
2626
+ },
2627
+ "title": "Attribute"
2628
+ }
2629
+ },
2630
+ "critical": {
2631
+ "type": "boolean"
2632
+ }
2633
+ },
2634
+ "title": "San"
2635
+ }
2636
+ },
2637
+ "title": "Extensions"
2638
+ },
2639
+ "issuer": {
2640
+ "type": "object",
2641
+ "properties": {
2642
+ "certificate": {
2643
+ "type": "string"
2644
+ },
2645
+ "chain": {
2646
+ "type": "array",
2647
+ "items": {
2648
+ "type": "object",
2649
+ "properties": {
2650
+ "certificate": {
2651
+ "type": "string"
2652
+ },
2653
+ "root": {
2654
+ "type": "boolean"
2655
+ },
2656
+ "serial_number": {
2657
+ "type": "string"
2658
+ },
2659
+ "subject_dn": {
2660
+ "type": "string"
2661
+ }
2662
+ },
2663
+ "title": "CertificateInfo"
2664
+ }
2665
+ },
2666
+ "root": {
2667
+ "type": "boolean"
2668
+ },
2669
+ "serial_number": {
2670
+ "type": "string"
2671
+ },
2672
+ "subject_dn": {
2673
+ "type": "string"
2674
+ }
2675
+ },
2676
+ "title": "Issuer"
2677
+ },
2678
+ "subject": {
2679
+ "type": "object",
2680
+ "properties": {
2681
+ "attributes": {
2682
+ "type": "array",
2683
+ "items": {
2684
+ "type": "object",
2685
+ "properties": {
2686
+ "id": {
2687
+ "type": "string"
2688
+ },
2689
+ "mandatory": {
2690
+ "type": "boolean"
2691
+ },
2692
+ "multiple": {
2693
+ "type": "boolean"
2694
+ },
2695
+ "sources": {
2696
+ "type": "array",
2697
+ "items": {
2698
+ "type": "object",
2699
+ "properties": {
2700
+ "mandatory": {
2701
+ "type": "boolean"
2702
+ },
2703
+ "value": {
2704
+ "type": "object"
2705
+ }
2706
+ },
2707
+ "title": "AttributeSource"
2708
+ }
2709
+ },
2710
+ "type": {
2711
+ "type": "string"
2712
+ },
2713
+ "value": {
2714
+ "type": "string"
2715
+ }
2716
+ },
2717
+ "title": "ExtendedAttribute"
2718
+ }
2719
+ }
2720
+ },
2721
+ "title": "Subject"
2722
+ },
2723
+ "validity": {
2724
+ "type": "object",
2725
+ "properties": {
2726
+ "duration": {
2727
+ "type": "integer"
2728
+ },
2729
+ "unit": {
2730
+ "type": "string"
2731
+ }
2732
+ },
2733
+ "title": "Validity"
2734
+ }
2735
+ },
2736
+ "title": "CertificateDetails"
2737
+ },
2738
+ "certificate_delivery_format": {
2739
+ "type": "string"
2740
+ },
2741
+ "duplicate_cert_policy": {
2742
+ "type": "boolean"
2743
+ },
2744
+ "enrollment": {
2745
+ "type": "object",
2746
+ "properties": {
2747
+ "client_type": {
2748
+ "type": "string"
2749
+ },
2750
+ "client_type_id": {
2751
+ "type": "string"
2752
+ }
2753
+ },
2754
+ "title": "Enrollment"
2755
+ },
2756
+ "id": {
2757
+ "type": "string"
2758
+ },
2759
+ "name": {
2760
+ "type": "string"
2761
+ },
2762
+ "private_key_attributes": {
2763
+ "type": "object",
2764
+ "properties": {
2765
+ "algorithm_oid": {
2766
+ "type": "string"
2767
+ },
2768
+ "crypto_providers": {
2769
+ "type": "object",
2770
+ "properties": {
2771
+ "provider": {
2772
+ "type": "array",
2773
+ "items": {
2774
+ "type": "string"
2775
+ }
2776
+ }
2777
+ },
2778
+ "title": "CryptoProviders"
2779
+ },
2780
+ "key_escrow_policy": {
2781
+ "type": "object",
2782
+ "properties": {
2783
+ "do_key_recovery_for_additional_enroll_request": {
2784
+ "type": "boolean"
2785
+ },
2786
+ "key_escrow_deployment_mode": {
2787
+ "type": "string"
2788
+ },
2789
+ "key_escrow_enabled": {
2790
+ "type": "boolean"
2791
+ },
2792
+ "key_recovery_dual_admin_approval_required": {
2793
+ "type": "boolean"
2794
+ }
2795
+ },
2796
+ "title": "KeyEscrowPolicyType"
2797
+ },
2798
+ "key_exportable": {
2799
+ "type": "boolean"
2800
+ },
2801
+ "key_protect": {
2802
+ "type": "boolean"
2803
+ },
2804
+ "key_size": {
2805
+ "type": "integer"
2806
+ },
2807
+ "key_sizes": {
2808
+ "type": "array",
2809
+ "items": {
2810
+ "type": "integer"
2811
+ }
2812
+ }
2813
+ },
2814
+ "title": "PrivateKeyAttributes"
2815
+ },
2816
+ "publish_to_public_directory": {
2817
+ "type": "boolean"
2818
+ },
2819
+ "renewal_period_days": {
2820
+ "type": "integer"
2821
+ },
2822
+ "signature_algorithm": {
2823
+ "type": "string"
2824
+ },
2825
+ "status": {
2826
+ "type": "string"
2827
+ }
2828
+ },
2829
+ "title": "GetProfileResponse"
2830
+ }
2831
+ }
2832
+ },
2833
+ "roles": [
2834
+ "admin"
2835
+ ],
2836
+ "route": {
2837
+ "verb": "GET",
2838
+ "path": "/getAllProfilesUsingGET"
2839
+ },
2840
+ "task": true
2841
+ },
2842
+ {
2843
+ "name": "getProfileUsingGET",
2844
+ "summary": "This API is used to get profile details for a given profile id",
2845
+ "description": "This API is used to get profile details for a given profile id",
2846
+ "input": [
2847
+ {
2848
+ "name": "profileId",
2849
+ "type": "string",
2850
+ "info": "profileId: string",
2851
+ "required": true,
2852
+ "schema": {
2853
+ "title": "profileId",
2854
+ "type": "string"
2855
+ }
2856
+ }
2857
+ ],
2858
+ "output": {
2859
+ "name": "result",
2860
+ "type": "object",
2861
+ "description": "A JSON Object containing status, code and the result",
2862
+ "schema": {
2863
+ "title": "result",
2864
+ "type": "object"
2865
+ }
2866
+ },
2867
+ "roles": [
2868
+ "admin"
2869
+ ],
2870
+ "route": {
2871
+ "verb": "POST",
2872
+ "path": "/getProfileUsingGET"
2873
+ },
2874
+ "task": true
2875
+ },
2876
+ {
2877
+ "name": "activateProfileUsingPUT",
2878
+ "summary": "This API is used to suspend a profile",
2879
+ "description": "This API is used to suspend a profile",
2880
+ "input": [
2881
+ {
2882
+ "name": "profileCreationRequest",
2883
+ "type": "object",
2884
+ "info": "profileCreationRequest: {\"bctOid\": \"string\", \"caId\": \"string\", \"duplicateCertPolicy\": \"boolean\", \"extendedKeyUsages\": {\"critical\": \"boolean\", \"extended_key_usages\": \"array\"}, \"keyEscrowPolicy\": {\"dual_admin_recovery\": \"boolean\", \"key_escrow_deployment_mode\": \"Must be one of [CLOUD, LOCAL]\", \"key_escrow_enabled\": \"boolean\"}, \"keySize\": \"string\", \"keyUsages\": {\"critical\": \"boolean\", \"key_usages\": \"array\"}, \"overrideCertValidityViaApi\": \"boolean\", \"profileName\": \"string\", \"profileOid\": \"string\", \"renewalPeriodDays\": 123, \"san\": {\"attributes\": [{\"id\": \"string\", \"mandatory\": \"boolean\", \"type\": \"string\", \"value\": \"string\"}], \"critical\": \"boolean\"}, \"signatureAlgorithm\": \"string\", \"subject\": {\"attributes\": [{\"id\": \"string\", \"mandatory\": \"boolean\", \"multiple\": \"boolean\", \"sources\": [{\"mandatory\": \"boolean\", \"value\": \"object\"}], \"type\": \"string\", \"value\": \"string\"}]}, \"validity\": {\"duration\": 123, \"unit\": \"string\"}}",
2885
+ "required": true,
2886
+ "schema": {
2887
+ "type": "object",
2888
+ "properties": {
2889
+ "bctOid": {
2890
+ "type": "string"
2891
+ },
2892
+ "caId": {
2893
+ "type": "string"
2894
+ },
2895
+ "duplicateCertPolicy": {
2896
+ "type": "boolean"
2897
+ },
2898
+ "extendedKeyUsages": {
2899
+ "type": "object",
2900
+ "properties": {
2901
+ "critical": {
2902
+ "type": "boolean"
2903
+ },
2904
+ "extended_key_usages": {
2905
+ "type": "array",
2906
+ "items": {
2907
+ "type": "string"
2908
+ }
2909
+ }
2910
+ },
2911
+ "title": "ExtendedKeyUsageListType"
2912
+ },
2913
+ "keyEscrowPolicy": {
2914
+ "type": "object",
2915
+ "properties": {
2916
+ "dual_admin_recovery": {
2917
+ "type": "boolean"
2918
+ },
2919
+ "key_escrow_deployment_mode": {
2920
+ "type": "string",
2921
+ "enum": [
2922
+ "CLOUD",
2923
+ "LOCAL"
2924
+ ]
2925
+ },
2926
+ "key_escrow_enabled": {
2927
+ "type": "boolean"
2928
+ }
2929
+ },
2930
+ "title": "KeyEscrowPolicy"
2931
+ },
2932
+ "keySize": {
2933
+ "type": "string"
2934
+ },
2935
+ "keyUsages": {
2936
+ "type": "object",
2937
+ "properties": {
2938
+ "critical": {
2939
+ "type": "boolean"
2940
+ },
2941
+ "key_usages": {
2942
+ "type": "array",
2943
+ "items": {
2944
+ "type": "string"
2945
+ }
2946
+ }
2947
+ },
2948
+ "title": "KeyUsageListType"
2949
+ },
2950
+ "overrideCertValidityViaApi": {
2951
+ "type": "boolean"
2952
+ },
2953
+ "profileName": {
2954
+ "type": "string"
2955
+ },
2956
+ "profileOid": {
2957
+ "type": "string"
2958
+ },
2959
+ "renewalPeriodDays": {
2960
+ "type": "integer"
2961
+ },
2962
+ "san": {
2963
+ "type": "object",
2964
+ "properties": {
2965
+ "attributes": {
2966
+ "type": "array",
2967
+ "items": {
2968
+ "type": "object",
2969
+ "properties": {
2970
+ "id": {
2971
+ "type": "string"
2972
+ },
2973
+ "mandatory": {
2974
+ "type": "boolean"
2975
+ },
2976
+ "type": {
2977
+ "type": "string"
2978
+ },
2979
+ "value": {
2980
+ "type": "string"
2981
+ }
2982
+ },
2983
+ "title": "Attribute"
2984
+ }
2985
+ },
2986
+ "critical": {
2987
+ "type": "boolean"
2988
+ }
2989
+ },
2990
+ "title": "San"
2991
+ },
2992
+ "signatureAlgorithm": {
2993
+ "type": "string"
2994
+ },
2995
+ "subject": {
2996
+ "type": "object",
2997
+ "properties": {
2998
+ "attributes": {
2999
+ "type": "array",
3000
+ "items": {
3001
+ "type": "object",
3002
+ "properties": {
3003
+ "id": {
3004
+ "type": "string"
3005
+ },
3006
+ "mandatory": {
3007
+ "type": "boolean"
3008
+ },
3009
+ "multiple": {
3010
+ "type": "boolean"
3011
+ },
3012
+ "sources": {
3013
+ "type": "array",
3014
+ "items": {
3015
+ "type": "object",
3016
+ "properties": {
3017
+ "mandatory": {
3018
+ "type": "boolean"
3019
+ },
3020
+ "value": {
3021
+ "type": "object"
3022
+ }
3023
+ },
3024
+ "title": "AttributeSource"
3025
+ }
3026
+ },
3027
+ "type": {
3028
+ "type": "string"
3029
+ },
3030
+ "value": {
3031
+ "type": "string"
3032
+ }
3033
+ },
3034
+ "title": "ExtendedAttribute"
3035
+ }
3036
+ }
3037
+ },
3038
+ "title": "Subject"
3039
+ },
3040
+ "validity": {
3041
+ "type": "object",
3042
+ "properties": {
3043
+ "duration": {
3044
+ "type": "integer"
3045
+ },
3046
+ "unit": {
3047
+ "type": "string"
3048
+ }
3049
+ },
3050
+ "title": "Validity"
3051
+ }
3052
+ },
3053
+ "title": "ProfileCreationRequest",
3054
+ "definitions": {}
3055
+ }
3056
+ }
3057
+ ],
3058
+ "output": {
3059
+ "name": "result",
3060
+ "type": "object",
3061
+ "description": "A JSON Object containing status, code and the result",
3062
+ "schema": {
3063
+ "title": "result",
3064
+ "type": "object"
3065
+ }
3066
+ },
3067
+ "roles": [
3068
+ "admin"
3069
+ ],
3070
+ "route": {
3071
+ "verb": "POST",
3072
+ "path": "/activateProfileUsingPUT"
3073
+ },
3074
+ "task": true
3075
+ },
3076
+ {
3077
+ "name": "createProfileUsingPOST",
3078
+ "summary": "This API is used to create a profile",
3079
+ "description": "This API is used to create a profile",
3080
+ "input": [
3081
+ {
3082
+ "name": "profileCreationRequest",
3083
+ "type": "object",
3084
+ "info": "profileCreationRequest: {\"bctOid\": \"string\", \"caId\": \"string\", \"duplicateCertPolicy\": \"boolean\", \"extendedKeyUsages\": {\"critical\": \"boolean\", \"extended_key_usages\": \"array\"}, \"keyEscrowPolicy\": {\"dual_admin_recovery\": \"boolean\", \"key_escrow_deployment_mode\": \"Must be one of [CLOUD, LOCAL]\", \"key_escrow_enabled\": \"boolean\"}, \"keySize\": \"string\", \"keyUsages\": {\"critical\": \"boolean\", \"key_usages\": \"array\"}, \"overrideCertValidityViaApi\": \"boolean\", \"profileName\": \"string\", \"profileOid\": \"string\", \"renewalPeriodDays\": 123, \"san\": {\"attributes\": [{\"id\": \"string\", \"mandatory\": \"boolean\", \"type\": \"string\", \"value\": \"string\"}], \"critical\": \"boolean\"}, \"signatureAlgorithm\": \"string\", \"subject\": {\"attributes\": [{\"id\": \"string\", \"mandatory\": \"boolean\", \"multiple\": \"boolean\", \"sources\": [{\"mandatory\": \"boolean\", \"value\": \"object\"}], \"type\": \"string\", \"value\": \"string\"}]}, \"validity\": {\"duration\": 123, \"unit\": \"string\"}}",
3085
+ "required": true,
3086
+ "schema": {
3087
+ "type": "object",
3088
+ "properties": {
3089
+ "bctOid": {
3090
+ "type": "string"
3091
+ },
3092
+ "caId": {
3093
+ "type": "string"
3094
+ },
3095
+ "duplicateCertPolicy": {
3096
+ "type": "boolean"
3097
+ },
3098
+ "extendedKeyUsages": {
3099
+ "type": "object",
3100
+ "properties": {
3101
+ "critical": {
3102
+ "type": "boolean"
3103
+ },
3104
+ "extended_key_usages": {
3105
+ "type": "array",
3106
+ "items": {
3107
+ "type": "string"
3108
+ }
3109
+ }
3110
+ },
3111
+ "title": "ExtendedKeyUsageListType"
3112
+ },
3113
+ "keyEscrowPolicy": {
3114
+ "type": "object",
3115
+ "properties": {
3116
+ "dual_admin_recovery": {
3117
+ "type": "boolean"
3118
+ },
3119
+ "key_escrow_deployment_mode": {
3120
+ "type": "string",
3121
+ "enum": [
3122
+ "CLOUD",
3123
+ "LOCAL"
3124
+ ]
3125
+ },
3126
+ "key_escrow_enabled": {
3127
+ "type": "boolean"
3128
+ }
3129
+ },
3130
+ "title": "KeyEscrowPolicy"
3131
+ },
3132
+ "keySize": {
3133
+ "type": "string"
3134
+ },
3135
+ "keyUsages": {
3136
+ "type": "object",
3137
+ "properties": {
3138
+ "critical": {
3139
+ "type": "boolean"
3140
+ },
3141
+ "key_usages": {
3142
+ "type": "array",
3143
+ "items": {
3144
+ "type": "string"
3145
+ }
3146
+ }
3147
+ },
3148
+ "title": "KeyUsageListType"
3149
+ },
3150
+ "overrideCertValidityViaApi": {
3151
+ "type": "boolean"
3152
+ },
3153
+ "profileName": {
3154
+ "type": "string"
3155
+ },
3156
+ "profileOid": {
3157
+ "type": "string"
3158
+ },
3159
+ "renewalPeriodDays": {
3160
+ "type": "integer"
3161
+ },
3162
+ "san": {
3163
+ "type": "object",
3164
+ "properties": {
3165
+ "attributes": {
3166
+ "type": "array",
3167
+ "items": {
3168
+ "type": "object",
3169
+ "properties": {
3170
+ "id": {
3171
+ "type": "string"
3172
+ },
3173
+ "mandatory": {
3174
+ "type": "boolean"
3175
+ },
3176
+ "type": {
3177
+ "type": "string"
3178
+ },
3179
+ "value": {
3180
+ "type": "string"
3181
+ }
3182
+ },
3183
+ "title": "Attribute"
3184
+ }
3185
+ },
3186
+ "critical": {
3187
+ "type": "boolean"
3188
+ }
3189
+ },
3190
+ "title": "San"
3191
+ },
3192
+ "signatureAlgorithm": {
3193
+ "type": "string"
3194
+ },
3195
+ "subject": {
3196
+ "type": "object",
3197
+ "properties": {
3198
+ "attributes": {
3199
+ "type": "array",
3200
+ "items": {
3201
+ "type": "object",
3202
+ "properties": {
3203
+ "id": {
3204
+ "type": "string"
3205
+ },
3206
+ "mandatory": {
3207
+ "type": "boolean"
3208
+ },
3209
+ "multiple": {
3210
+ "type": "boolean"
3211
+ },
3212
+ "sources": {
3213
+ "type": "array",
3214
+ "items": {
3215
+ "type": "object",
3216
+ "properties": {
3217
+ "mandatory": {
3218
+ "type": "boolean"
3219
+ },
3220
+ "value": {
3221
+ "type": "object"
3222
+ }
3223
+ },
3224
+ "title": "AttributeSource"
3225
+ }
3226
+ },
3227
+ "type": {
3228
+ "type": "string"
3229
+ },
3230
+ "value": {
3231
+ "type": "string"
3232
+ }
3233
+ },
3234
+ "title": "ExtendedAttribute"
3235
+ }
3236
+ }
3237
+ },
3238
+ "title": "Subject"
3239
+ },
3240
+ "validity": {
3241
+ "type": "object",
3242
+ "properties": {
3243
+ "duration": {
3244
+ "type": "integer"
3245
+ },
3246
+ "unit": {
3247
+ "type": "string"
3248
+ }
3249
+ },
3250
+ "title": "Validity"
3251
+ }
3252
+ },
3253
+ "title": "ProfileCreationRequest",
3254
+ "definitions": {}
3255
+ }
3256
+ }
3257
+ ],
3258
+ "output": {
3259
+ "name": "result",
3260
+ "type": "object",
3261
+ "description": "A JSON Object containing status, code and the result",
3262
+ "schema": {
3263
+ "title": "result",
3264
+ "type": "object"
3265
+ }
3266
+ },
3267
+ "roles": [
3268
+ "admin"
3269
+ ],
3270
+ "route": {
3271
+ "verb": "POST",
3272
+ "path": "/createProfileUsingPOST"
3273
+ },
3274
+ "task": true
3275
+ },
3276
+ {
3277
+ "name": "deleteProfileUsingPUT",
3278
+ "summary": "This API is used to delete a profile",
3279
+ "description": "This API is used to delete a profile",
3280
+ "input": [
3281
+ {
3282
+ "name": "profileCreationRequest",
3283
+ "type": "object",
3284
+ "info": "profileCreationRequest: {\"bctOid\": \"string\", \"caId\": \"string\", \"duplicateCertPolicy\": \"boolean\", \"extendedKeyUsages\": {\"critical\": \"boolean\", \"extended_key_usages\": \"array\"}, \"keyEscrowPolicy\": {\"dual_admin_recovery\": \"boolean\", \"key_escrow_deployment_mode\": \"Must be one of [CLOUD, LOCAL]\", \"key_escrow_enabled\": \"boolean\"}, \"keySize\": \"string\", \"keyUsages\": {\"critical\": \"boolean\", \"key_usages\": \"array\"}, \"overrideCertValidityViaApi\": \"boolean\", \"profileName\": \"string\", \"profileOid\": \"string\", \"renewalPeriodDays\": 123, \"san\": {\"attributes\": [{\"id\": \"string\", \"mandatory\": \"boolean\", \"type\": \"string\", \"value\": \"string\"}], \"critical\": \"boolean\"}, \"signatureAlgorithm\": \"string\", \"subject\": {\"attributes\": [{\"id\": \"string\", \"mandatory\": \"boolean\", \"multiple\": \"boolean\", \"sources\": [{\"mandatory\": \"boolean\", \"value\": \"object\"}], \"type\": \"string\", \"value\": \"string\"}]}, \"validity\": {\"duration\": 123, \"unit\": \"string\"}}",
3285
+ "required": true,
3286
+ "schema": {
3287
+ "type": "object",
3288
+ "properties": {
3289
+ "bctOid": {
3290
+ "type": "string"
3291
+ },
3292
+ "caId": {
3293
+ "type": "string"
3294
+ },
3295
+ "duplicateCertPolicy": {
3296
+ "type": "boolean"
3297
+ },
3298
+ "extendedKeyUsages": {
3299
+ "type": "object",
3300
+ "properties": {
3301
+ "critical": {
3302
+ "type": "boolean"
3303
+ },
3304
+ "extended_key_usages": {
3305
+ "type": "array",
3306
+ "items": {
3307
+ "type": "string"
3308
+ }
3309
+ }
3310
+ },
3311
+ "title": "ExtendedKeyUsageListType"
3312
+ },
3313
+ "keyEscrowPolicy": {
3314
+ "type": "object",
3315
+ "properties": {
3316
+ "dual_admin_recovery": {
3317
+ "type": "boolean"
3318
+ },
3319
+ "key_escrow_deployment_mode": {
3320
+ "type": "string",
3321
+ "enum": [
3322
+ "CLOUD",
3323
+ "LOCAL"
3324
+ ]
3325
+ },
3326
+ "key_escrow_enabled": {
3327
+ "type": "boolean"
3328
+ }
3329
+ },
3330
+ "title": "KeyEscrowPolicy"
3331
+ },
3332
+ "keySize": {
3333
+ "type": "string"
3334
+ },
3335
+ "keyUsages": {
3336
+ "type": "object",
3337
+ "properties": {
3338
+ "critical": {
3339
+ "type": "boolean"
3340
+ },
3341
+ "key_usages": {
3342
+ "type": "array",
3343
+ "items": {
3344
+ "type": "string"
3345
+ }
3346
+ }
3347
+ },
3348
+ "title": "KeyUsageListType"
3349
+ },
3350
+ "overrideCertValidityViaApi": {
3351
+ "type": "boolean"
3352
+ },
3353
+ "profileName": {
3354
+ "type": "string"
3355
+ },
3356
+ "profileOid": {
3357
+ "type": "string"
3358
+ },
3359
+ "renewalPeriodDays": {
3360
+ "type": "integer"
3361
+ },
3362
+ "san": {
3363
+ "type": "object",
3364
+ "properties": {
3365
+ "attributes": {
3366
+ "type": "array",
3367
+ "items": {
3368
+ "type": "object",
3369
+ "properties": {
3370
+ "id": {
3371
+ "type": "string"
3372
+ },
3373
+ "mandatory": {
3374
+ "type": "boolean"
3375
+ },
3376
+ "type": {
3377
+ "type": "string"
3378
+ },
3379
+ "value": {
3380
+ "type": "string"
3381
+ }
3382
+ },
3383
+ "title": "Attribute"
3384
+ }
3385
+ },
3386
+ "critical": {
3387
+ "type": "boolean"
3388
+ }
3389
+ },
3390
+ "title": "San"
3391
+ },
3392
+ "signatureAlgorithm": {
3393
+ "type": "string"
3394
+ },
3395
+ "subject": {
3396
+ "type": "object",
3397
+ "properties": {
3398
+ "attributes": {
3399
+ "type": "array",
3400
+ "items": {
3401
+ "type": "object",
3402
+ "properties": {
3403
+ "id": {
3404
+ "type": "string"
3405
+ },
3406
+ "mandatory": {
3407
+ "type": "boolean"
3408
+ },
3409
+ "multiple": {
3410
+ "type": "boolean"
3411
+ },
3412
+ "sources": {
3413
+ "type": "array",
3414
+ "items": {
3415
+ "type": "object",
3416
+ "properties": {
3417
+ "mandatory": {
3418
+ "type": "boolean"
3419
+ },
3420
+ "value": {
3421
+ "type": "object"
3422
+ }
3423
+ },
3424
+ "title": "AttributeSource"
3425
+ }
3426
+ },
3427
+ "type": {
3428
+ "type": "string"
3429
+ },
3430
+ "value": {
3431
+ "type": "string"
3432
+ }
3433
+ },
3434
+ "title": "ExtendedAttribute"
3435
+ }
3436
+ }
3437
+ },
3438
+ "title": "Subject"
3439
+ },
3440
+ "validity": {
3441
+ "type": "object",
3442
+ "properties": {
3443
+ "duration": {
3444
+ "type": "integer"
3445
+ },
3446
+ "unit": {
3447
+ "type": "string"
3448
+ }
3449
+ },
3450
+ "title": "Validity"
3451
+ }
3452
+ },
3453
+ "title": "ProfileCreationRequest",
3454
+ "definitions": {}
3455
+ }
3456
+ }
3457
+ ],
3458
+ "output": {
3459
+ "name": "result",
3460
+ "type": "object",
3461
+ "description": "A JSON Object containing status, code and the result",
3462
+ "schema": {
3463
+ "title": "result",
3464
+ "type": "object"
3465
+ }
3466
+ },
3467
+ "roles": [
3468
+ "admin"
3469
+ ],
3470
+ "route": {
3471
+ "verb": "POST",
3472
+ "path": "/deleteProfileUsingPUT"
3473
+ },
3474
+ "task": true
3475
+ },
3476
+ {
3477
+ "name": "updateProfileUsingPUT",
3478
+ "summary": "This API is used to create a profile",
3479
+ "description": "This API is used to create a profile",
3480
+ "input": [
3481
+ {
3482
+ "name": "profileCreationRequest",
3483
+ "type": "object",
3484
+ "info": "profileCreationRequest: {\"bctOid\": \"string\", \"caId\": \"string\", \"duplicateCertPolicy\": \"boolean\", \"extendedKeyUsages\": {\"critical\": \"boolean\", \"extended_key_usages\": \"array\"}, \"keyEscrowPolicy\": {\"dual_admin_recovery\": \"boolean\", \"key_escrow_deployment_mode\": \"Must be one of [CLOUD, LOCAL]\", \"key_escrow_enabled\": \"boolean\"}, \"keySize\": \"string\", \"keyUsages\": {\"critical\": \"boolean\", \"key_usages\": \"array\"}, \"overrideCertValidityViaApi\": \"boolean\", \"profileName\": \"string\", \"profileOid\": \"string\", \"renewalPeriodDays\": 123, \"san\": {\"attributes\": [{\"id\": \"string\", \"mandatory\": \"boolean\", \"type\": \"string\", \"value\": \"string\"}], \"critical\": \"boolean\"}, \"signatureAlgorithm\": \"string\", \"subject\": {\"attributes\": [{\"id\": \"string\", \"mandatory\": \"boolean\", \"multiple\": \"boolean\", \"sources\": [{\"mandatory\": \"boolean\", \"value\": \"object\"}], \"type\": \"string\", \"value\": \"string\"}]}, \"validity\": {\"duration\": 123, \"unit\": \"string\"}}",
3485
+ "required": true,
3486
+ "schema": {
3487
+ "type": "object",
3488
+ "properties": {
3489
+ "bctOid": {
3490
+ "type": "string"
3491
+ },
3492
+ "caId": {
3493
+ "type": "string"
3494
+ },
3495
+ "duplicateCertPolicy": {
3496
+ "type": "boolean"
3497
+ },
3498
+ "extendedKeyUsages": {
3499
+ "type": "object",
3500
+ "properties": {
3501
+ "critical": {
3502
+ "type": "boolean"
3503
+ },
3504
+ "extended_key_usages": {
3505
+ "type": "array",
3506
+ "items": {
3507
+ "type": "string"
3508
+ }
3509
+ }
3510
+ },
3511
+ "title": "ExtendedKeyUsageListType"
3512
+ },
3513
+ "keyEscrowPolicy": {
3514
+ "type": "object",
3515
+ "properties": {
3516
+ "dual_admin_recovery": {
3517
+ "type": "boolean"
3518
+ },
3519
+ "key_escrow_deployment_mode": {
3520
+ "type": "string",
3521
+ "enum": [
3522
+ "CLOUD",
3523
+ "LOCAL"
3524
+ ]
3525
+ },
3526
+ "key_escrow_enabled": {
3527
+ "type": "boolean"
3528
+ }
3529
+ },
3530
+ "title": "KeyEscrowPolicy"
3531
+ },
3532
+ "keySize": {
3533
+ "type": "string"
3534
+ },
3535
+ "keyUsages": {
3536
+ "type": "object",
3537
+ "properties": {
3538
+ "critical": {
3539
+ "type": "boolean"
3540
+ },
3541
+ "key_usages": {
3542
+ "type": "array",
3543
+ "items": {
3544
+ "type": "string"
3545
+ }
3546
+ }
3547
+ },
3548
+ "title": "KeyUsageListType"
3549
+ },
3550
+ "overrideCertValidityViaApi": {
3551
+ "type": "boolean"
3552
+ },
3553
+ "profileName": {
3554
+ "type": "string"
3555
+ },
3556
+ "profileOid": {
3557
+ "type": "string"
3558
+ },
3559
+ "renewalPeriodDays": {
3560
+ "type": "integer"
3561
+ },
3562
+ "san": {
3563
+ "type": "object",
3564
+ "properties": {
3565
+ "attributes": {
3566
+ "type": "array",
3567
+ "items": {
3568
+ "type": "object",
3569
+ "properties": {
3570
+ "id": {
3571
+ "type": "string"
3572
+ },
3573
+ "mandatory": {
3574
+ "type": "boolean"
3575
+ },
3576
+ "type": {
3577
+ "type": "string"
3578
+ },
3579
+ "value": {
3580
+ "type": "string"
3581
+ }
3582
+ },
3583
+ "title": "Attribute"
3584
+ }
3585
+ },
3586
+ "critical": {
3587
+ "type": "boolean"
3588
+ }
3589
+ },
3590
+ "title": "San"
3591
+ },
3592
+ "signatureAlgorithm": {
3593
+ "type": "string"
3594
+ },
3595
+ "subject": {
3596
+ "type": "object",
3597
+ "properties": {
3598
+ "attributes": {
3599
+ "type": "array",
3600
+ "items": {
3601
+ "type": "object",
3602
+ "properties": {
3603
+ "id": {
3604
+ "type": "string"
3605
+ },
3606
+ "mandatory": {
3607
+ "type": "boolean"
3608
+ },
3609
+ "multiple": {
3610
+ "type": "boolean"
3611
+ },
3612
+ "sources": {
3613
+ "type": "array",
3614
+ "items": {
3615
+ "type": "object",
3616
+ "properties": {
3617
+ "mandatory": {
3618
+ "type": "boolean"
3619
+ },
3620
+ "value": {
3621
+ "type": "object"
3622
+ }
3623
+ },
3624
+ "title": "AttributeSource"
3625
+ }
3626
+ },
3627
+ "type": {
3628
+ "type": "string"
3629
+ },
3630
+ "value": {
3631
+ "type": "string"
3632
+ }
3633
+ },
3634
+ "title": "ExtendedAttribute"
3635
+ }
3636
+ }
3637
+ },
3638
+ "title": "Subject"
3639
+ },
3640
+ "validity": {
3641
+ "type": "object",
3642
+ "properties": {
3643
+ "duration": {
3644
+ "type": "integer"
3645
+ },
3646
+ "unit": {
3647
+ "type": "string"
3648
+ }
3649
+ },
3650
+ "title": "Validity"
3651
+ }
3652
+ },
3653
+ "title": "ProfileCreationRequest",
3654
+ "definitions": {}
3655
+ }
3656
+ }
3657
+ ],
3658
+ "output": {
3659
+ "name": "result",
3660
+ "type": "object",
3661
+ "description": "A JSON Object containing status, code and the result",
3662
+ "schema": {
3663
+ "title": "result",
3664
+ "type": "object"
3665
+ }
3666
+ },
3667
+ "roles": [
3668
+ "admin"
3669
+ ],
3670
+ "route": {
3671
+ "verb": "POST",
3672
+ "path": "/updateProfileUsingPUT"
3673
+ },
3674
+ "task": true
3675
+ },
3676
+ {
3677
+ "name": "suspendProfileUsingPUT",
3678
+ "summary": "This API is used to suspend a profile",
3679
+ "description": "This API is used to suspend a profile",
3680
+ "input": [
3681
+ {
3682
+ "name": "profileCreationRequest",
3683
+ "type": "object",
3684
+ "info": "profileCreationRequest: {\"bctOid\": \"string\", \"caId\": \"string\", \"duplicateCertPolicy\": \"boolean\", \"extendedKeyUsages\": {\"critical\": \"boolean\", \"extended_key_usages\": \"array\"}, \"keyEscrowPolicy\": {\"dual_admin_recovery\": \"boolean\", \"key_escrow_deployment_mode\": \"Must be one of [CLOUD, LOCAL]\", \"key_escrow_enabled\": \"boolean\"}, \"keySize\": \"string\", \"keyUsages\": {\"critical\": \"boolean\", \"key_usages\": \"array\"}, \"overrideCertValidityViaApi\": \"boolean\", \"profileName\": \"string\", \"profileOid\": \"string\", \"renewalPeriodDays\": 123, \"san\": {\"attributes\": [{\"id\": \"string\", \"mandatory\": \"boolean\", \"type\": \"string\", \"value\": \"string\"}], \"critical\": \"boolean\"}, \"signatureAlgorithm\": \"string\", \"subject\": {\"attributes\": [{\"id\": \"string\", \"mandatory\": \"boolean\", \"multiple\": \"boolean\", \"sources\": [{\"mandatory\": \"boolean\", \"value\": \"object\"}], \"type\": \"string\", \"value\": \"string\"}]}, \"validity\": {\"duration\": 123, \"unit\": \"string\"}}",
3685
+ "required": true,
3686
+ "schema": {
3687
+ "type": "object",
3688
+ "properties": {
3689
+ "bctOid": {
3690
+ "type": "string"
3691
+ },
3692
+ "caId": {
3693
+ "type": "string"
3694
+ },
3695
+ "duplicateCertPolicy": {
3696
+ "type": "boolean"
3697
+ },
3698
+ "extendedKeyUsages": {
3699
+ "type": "object",
3700
+ "properties": {
3701
+ "critical": {
3702
+ "type": "boolean"
3703
+ },
3704
+ "extended_key_usages": {
3705
+ "type": "array",
3706
+ "items": {
3707
+ "type": "string"
3708
+ }
3709
+ }
3710
+ },
3711
+ "title": "ExtendedKeyUsageListType"
3712
+ },
3713
+ "keyEscrowPolicy": {
3714
+ "type": "object",
3715
+ "properties": {
3716
+ "dual_admin_recovery": {
3717
+ "type": "boolean"
3718
+ },
3719
+ "key_escrow_deployment_mode": {
3720
+ "type": "string",
3721
+ "enum": [
3722
+ "CLOUD",
3723
+ "LOCAL"
3724
+ ]
3725
+ },
3726
+ "key_escrow_enabled": {
3727
+ "type": "boolean"
3728
+ }
3729
+ },
3730
+ "title": "KeyEscrowPolicy"
3731
+ },
3732
+ "keySize": {
3733
+ "type": "string"
3734
+ },
3735
+ "keyUsages": {
3736
+ "type": "object",
3737
+ "properties": {
3738
+ "critical": {
3739
+ "type": "boolean"
3740
+ },
3741
+ "key_usages": {
3742
+ "type": "array",
3743
+ "items": {
3744
+ "type": "string"
3745
+ }
3746
+ }
3747
+ },
3748
+ "title": "KeyUsageListType"
3749
+ },
3750
+ "overrideCertValidityViaApi": {
3751
+ "type": "boolean"
3752
+ },
3753
+ "profileName": {
3754
+ "type": "string"
3755
+ },
3756
+ "profileOid": {
3757
+ "type": "string"
3758
+ },
3759
+ "renewalPeriodDays": {
3760
+ "type": "integer"
3761
+ },
3762
+ "san": {
3763
+ "type": "object",
3764
+ "properties": {
3765
+ "attributes": {
3766
+ "type": "array",
3767
+ "items": {
3768
+ "type": "object",
3769
+ "properties": {
3770
+ "id": {
3771
+ "type": "string"
3772
+ },
3773
+ "mandatory": {
3774
+ "type": "boolean"
3775
+ },
3776
+ "type": {
3777
+ "type": "string"
3778
+ },
3779
+ "value": {
3780
+ "type": "string"
3781
+ }
3782
+ },
3783
+ "title": "Attribute"
3784
+ }
3785
+ },
3786
+ "critical": {
3787
+ "type": "boolean"
3788
+ }
3789
+ },
3790
+ "title": "San"
3791
+ },
3792
+ "signatureAlgorithm": {
3793
+ "type": "string"
3794
+ },
3795
+ "subject": {
3796
+ "type": "object",
3797
+ "properties": {
3798
+ "attributes": {
3799
+ "type": "array",
3800
+ "items": {
3801
+ "type": "object",
3802
+ "properties": {
3803
+ "id": {
3804
+ "type": "string"
3805
+ },
3806
+ "mandatory": {
3807
+ "type": "boolean"
3808
+ },
3809
+ "multiple": {
3810
+ "type": "boolean"
3811
+ },
3812
+ "sources": {
3813
+ "type": "array",
3814
+ "items": {
3815
+ "type": "object",
3816
+ "properties": {
3817
+ "mandatory": {
3818
+ "type": "boolean"
3819
+ },
3820
+ "value": {
3821
+ "type": "object"
3822
+ }
3823
+ },
3824
+ "title": "AttributeSource"
3825
+ }
3826
+ },
3827
+ "type": {
3828
+ "type": "string"
3829
+ },
3830
+ "value": {
3831
+ "type": "string"
3832
+ }
3833
+ },
3834
+ "title": "ExtendedAttribute"
3835
+ }
3836
+ }
3837
+ },
3838
+ "title": "Subject"
3839
+ },
3840
+ "validity": {
3841
+ "type": "object",
3842
+ "properties": {
3843
+ "duration": {
3844
+ "type": "integer"
3845
+ },
3846
+ "unit": {
3847
+ "type": "string"
3848
+ }
3849
+ },
3850
+ "title": "Validity"
3851
+ }
3852
+ },
3853
+ "title": "ProfileCreationRequest",
3854
+ "definitions": {}
3855
+ }
3856
+ }
3857
+ ],
3858
+ "output": {
3859
+ "name": "result",
3860
+ "type": "object",
3861
+ "description": "A JSON Object containing status, code and the result",
3862
+ "schema": {
3863
+ "title": "result",
3864
+ "type": "object"
3865
+ }
3866
+ },
3867
+ "roles": [
3868
+ "admin"
3869
+ ],
3870
+ "route": {
3871
+ "verb": "POST",
3872
+ "path": "/suspendProfileUsingPUT"
3873
+ },
3874
+ "task": true
3875
+ },
3876
+ {
3877
+ "name": "testCreateUsingPOST",
3878
+ "summary": "This API is used to create a profile",
3879
+ "description": "This API is used to create a profile",
3880
+ "input": [],
3881
+ "output": {
3882
+ "name": "result",
3883
+ "type": "object",
3884
+ "description": "A JSON Object containing status, code and the result",
3885
+ "schema": {
3886
+ "title": "result",
3887
+ "type": "object"
3888
+ }
3889
+ },
3890
+ "roles": [
3891
+ "admin"
3892
+ ],
3893
+ "route": {
3894
+ "verb": "GET",
3895
+ "path": "/testCreateUsingPOST"
3896
+ },
3897
+ "task": true
3898
+ },
3899
+ {
3900
+ "name": "searchCertUsingPOST",
3901
+ "summary": "This API is used to search for certificates.",
3902
+ "description": "This API is used to search for certificates.",
3903
+ "input": [
3904
+ {
3905
+ "name": "searchReq",
3906
+ "type": "object",
3907
+ "info": "searchReq: {\"common_name\": \"string\", \"email\": \"string\", \"issuing_ca\": \"string\", \"profile_id\": \"string\", \"seat_id\": \"string\", \"serial_number\": \"string\", \"start_index\": 123, \"status\": \"string\", \"valid_from\": \"string\", \"valid_to\": \"string\"}",
3908
+ "required": true,
3909
+ "schema": {
3910
+ "type": "object",
3911
+ "properties": {
3912
+ "common_name": {
3913
+ "type": "string"
3914
+ },
3915
+ "email": {
3916
+ "type": "string"
3917
+ },
3918
+ "issuing_ca": {
3919
+ "type": "string"
3920
+ },
3921
+ "profile_id": {
3922
+ "type": "string"
3923
+ },
3924
+ "seat_id": {
3925
+ "type": "string"
3926
+ },
3927
+ "serial_number": {
3928
+ "type": "string"
3929
+ },
3930
+ "start_index": {
3931
+ "type": "integer"
3932
+ },
3933
+ "status": {
3934
+ "type": "string"
3935
+ },
3936
+ "valid_from": {
3937
+ "type": "string"
3938
+ },
3939
+ "valid_to": {
3940
+ "type": "string"
3941
+ }
3942
+ },
3943
+ "title": "SearchCertificateRequest",
3944
+ "definitions": {}
3945
+ }
3946
+ }
3947
+ ],
3948
+ "output": {
3949
+ "name": "result",
3950
+ "type": "object",
3951
+ "description": "A JSON Object containing status, code and the result",
3952
+ "schema": {
3953
+ "title": "result",
3954
+ "type": "object"
3955
+ }
3956
+ },
3957
+ "roles": [
3958
+ "admin"
3959
+ ],
3960
+ "route": {
3961
+ "verb": "POST",
3962
+ "path": "/searchCertUsingPOST"
3963
+ },
3964
+ "task": true
3965
+ },
3966
+ {
3967
+ "name": "createSeatUsingPOST",
3968
+ "summary": "This API is used to create a seat. This seat can be used for a user, device, server or organizatio",
3969
+ "description": "This API is used to create a seat. This seat can be used for a user, device, server or organization seat pool.",
3970
+ "input": [
3971
+ {
3972
+ "name": "createSeatRequest",
3973
+ "type": "object",
3974
+ "info": "createSeatRequest: {\"email\": \"string\", \"phone\": \"string\", \"seat_id\": \"string\", \"seat_name\": \"string\"}",
3975
+ "required": true,
3976
+ "schema": {
3977
+ "type": "object",
3978
+ "properties": {
3979
+ "email": {
3980
+ "type": "string"
3981
+ },
3982
+ "phone": {
3983
+ "type": "string"
3984
+ },
3985
+ "seat_id": {
3986
+ "type": "string"
3987
+ },
3988
+ "seat_name": {
3989
+ "type": "string"
3990
+ }
3991
+ },
3992
+ "title": "CreateSeatRequest",
3993
+ "definitions": {}
3994
+ }
3995
+ }
3996
+ ],
3997
+ "output": {
3998
+ "name": "result",
3999
+ "type": "object",
4000
+ "description": "A JSON Object containing status, code and the result",
4001
+ "schema": {
4002
+ "title": "result",
4003
+ "type": "object"
4004
+ }
4005
+ },
4006
+ "roles": [
4007
+ "admin"
4008
+ ],
4009
+ "route": {
4010
+ "verb": "POST",
4011
+ "path": "/createSeatUsingPOST"
4012
+ },
4013
+ "task": true
4014
+ },
4015
+ {
4016
+ "name": "getSeatUsingGET",
4017
+ "summary": "This API is used to get information regarding a seat.",
4018
+ "description": "This API is used to get information regarding a seat.",
4019
+ "input": [
4020
+ {
4021
+ "name": "seatId",
4022
+ "type": "string",
4023
+ "info": "seatId: string",
4024
+ "required": true,
4025
+ "schema": {
4026
+ "title": "seatId",
4027
+ "type": "string"
4028
+ }
4029
+ }
4030
+ ],
4031
+ "output": {
4032
+ "name": "result",
4033
+ "type": "object",
4034
+ "description": "A JSON Object containing status, code and the result",
4035
+ "schema": {
4036
+ "title": "result",
4037
+ "type": "object"
4038
+ }
4039
+ },
4040
+ "roles": [
4041
+ "admin"
4042
+ ],
4043
+ "route": {
4044
+ "verb": "POST",
4045
+ "path": "/getSeatUsingGET"
4046
+ },
4047
+ "task": true
4048
+ },
4049
+ {
4050
+ "name": "updateSeatUsingPUT",
4051
+ "summary": "This API is used to change the seat details.",
4052
+ "description": "This API is used to change the seat details.",
4053
+ "input": [
4054
+ {
4055
+ "name": "seatId",
4056
+ "type": "string",
4057
+ "info": "seatId: string",
4058
+ "required": true,
4059
+ "schema": {
4060
+ "title": "seatId",
4061
+ "type": "string"
4062
+ }
4063
+ },
4064
+ {
4065
+ "name": "updateSeatRequest",
4066
+ "type": "object",
4067
+ "info": "updateSeatRequest: {\"email\": \"string\", \"phone\": \"string\", \"seat_name\": \"string\"}",
4068
+ "required": true,
4069
+ "schema": {
4070
+ "type": "object",
4071
+ "properties": {
4072
+ "email": {
4073
+ "type": "string"
4074
+ },
4075
+ "phone": {
4076
+ "type": "string"
4077
+ },
4078
+ "seat_name": {
4079
+ "type": "string"
4080
+ }
4081
+ },
4082
+ "title": "UpdateSeatRequest",
4083
+ "definitions": {}
4084
+ }
4085
+ }
4086
+ ],
4087
+ "output": {
4088
+ "name": "result",
4089
+ "type": "object",
4090
+ "description": "A JSON Object containing status, code and the result",
4091
+ "schema": {
4092
+ "title": "result",
4093
+ "type": "object"
4094
+ }
4095
+ },
4096
+ "roles": [
4097
+ "admin"
4098
+ ],
4099
+ "route": {
4100
+ "verb": "POST",
4101
+ "path": "/updateSeatUsingPUT"
4102
+ },
4103
+ "task": true
4104
+ },
4105
+ {
4106
+ "name": "deleteSeatUsingDELETE",
4107
+ "summary": "This API is used to delete a seat. Deleting a seat will revoke all the certificates associated to t",
4108
+ "description": "This API is used to delete a seat. Deleting a seat will revoke all the certificates associated to the specified seat.",
4109
+ "input": [
4110
+ {
4111
+ "name": "seatId",
4112
+ "type": "string",
4113
+ "info": "seatId: string",
4114
+ "required": true,
4115
+ "schema": {
4116
+ "title": "seatId",
4117
+ "type": "string"
4118
+ }
4119
+ }
4120
+ ],
4121
+ "output": {
4122
+ "name": "result",
4123
+ "type": "object",
4124
+ "description": "A JSON Object containing status, code and the result",
4125
+ "schema": {
4126
+ "title": "result",
4127
+ "type": "object"
4128
+ }
4129
+ },
4130
+ "roles": [
4131
+ "admin"
4132
+ ],
4133
+ "route": {
4134
+ "verb": "POST",
4135
+ "path": "/deleteSeatUsingDELETE"
4136
+ },
4137
+ "task": true
4138
+ }
4139
+ ],
4140
+ "views": []
4141
+ }