@sphereon/ssi-sdk.contact-manager 0.11.1-next.65

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.
@@ -0,0 +1,661 @@
1
+ {
2
+ "IContactManager": {
3
+ "components": {
4
+ "schemas": {
5
+ "IGetContactArgs": {
6
+ "type": "object",
7
+ "properties": {
8
+ "contactId": {
9
+ "type": "string"
10
+ }
11
+ },
12
+ "required": ["contactId"]
13
+ },
14
+ "IGetContactsArgs": {
15
+ "type": "object",
16
+ "properties": {
17
+ "filter": {
18
+ "type": "array",
19
+ "items": {
20
+ "type": "object"
21
+ }
22
+ }
23
+ }
24
+ },
25
+ "IAddContactArgs": {
26
+ "type": "object",
27
+ "properties": {
28
+ "contact": {
29
+ "$ref": "#/components/schemas/IBasicContact"
30
+ }
31
+ },
32
+ "required": ["party"]
33
+ },
34
+ "IRemoveContactArgs": {
35
+ "type": "object",
36
+ "properties": {
37
+ "contactId": {
38
+ "type": "string"
39
+ }
40
+ },
41
+ "required": ["contactId"]
42
+ },
43
+ "IUpdateContactArgs": {
44
+ "type": "object",
45
+ "properties": {
46
+ "contact": {
47
+ "$ref": "#/components/schemas/IBasicContact"
48
+ }
49
+ },
50
+ "required": ["party"]
51
+ },
52
+ "IGetIdentityArgs": {
53
+ "type": "object",
54
+ "properties": {
55
+ "identityId": {
56
+ "type": "string"
57
+ }
58
+ },
59
+ "required": ["identityId"]
60
+ },
61
+ "IGetIdentitiesArgs": {
62
+ "type": "object",
63
+ "properties": {
64
+ "contactId": {
65
+ "type": "string"
66
+ }
67
+ },
68
+ "required": ["contactId"]
69
+ },
70
+ "IAddIdentityArgs": {
71
+ "type": "object",
72
+ "properties": {
73
+ "identity": {
74
+ "$ref": "#/components/schemas/IIdentity"
75
+ }
76
+ },
77
+ "required": ["identity"]
78
+ },
79
+ "IRemoveIdentityArgs": {
80
+ "type": "object",
81
+ "properties": {
82
+ "identityId": {
83
+ "type": "string"
84
+ }
85
+ },
86
+ "required": ["identityId"]
87
+ },
88
+ "IUpdateIdentityArgs": {
89
+ "type": "object",
90
+ "properties": {
91
+ "identity": {
92
+ "$ref": "#/components/schemas/IIdentity"
93
+ }
94
+ },
95
+ "required": ["identity"]
96
+ },
97
+ "IBasicContact": {
98
+ "type": "object",
99
+ "properties": {
100
+ "name": {
101
+ "type": "string"
102
+ },
103
+ "alias": {
104
+ "type": "string"
105
+ },
106
+ "uri": {
107
+ "type": "string"
108
+ },
109
+ "identities": {
110
+ "type": "array",
111
+ "items": {
112
+ "$ref": "#/components/schemas/IBasicIdentity"
113
+ }
114
+ }
115
+ },
116
+ "required": ["name", "alias"]
117
+ },
118
+ "IContact": {
119
+ "type": "object",
120
+ "properties": {
121
+ "id": {
122
+ "type": "string"
123
+ },
124
+ "name": {
125
+ "type": "string"
126
+ },
127
+ "alias": {
128
+ "type": "string"
129
+ },
130
+ "uri": {
131
+ "type": "string"
132
+ },
133
+ "identities": {
134
+ "type": "array",
135
+ "items": {
136
+ "$ref": "#/components/schemas/IIdentity"
137
+ }
138
+ },
139
+ "createdAt": {
140
+ "type": "string",
141
+ "format": "date-time"
142
+ },
143
+ "lastUpdatedAt": {
144
+ "type": "string",
145
+ "format": "date-time"
146
+ }
147
+ },
148
+ "required": ["id", "name", "alias", "createdAt", "lastUpdatedAt"]
149
+ },
150
+ "IMetadataItem": {
151
+ "type": "object",
152
+ "properties": {
153
+ "id": {
154
+ "type": "string"
155
+ },
156
+ "label": {
157
+ "type": "string"
158
+ },
159
+ "value": {
160
+ "type": "string"
161
+ }
162
+ },
163
+ "required": ["id", "label", "value"]
164
+ },
165
+ "BasicMetadataItem": {
166
+ "type": "object",
167
+ "properties": {
168
+ "label": {
169
+ "type": "string"
170
+ },
171
+ "value": {
172
+ "type": "string"
173
+ }
174
+ },
175
+ "required": ["label", "value"]
176
+ },
177
+ "IBasicIdentity": {
178
+ "type": "object",
179
+ "properties": {
180
+ "alias": {
181
+ "type": "string"
182
+ },
183
+ "identifier": {
184
+ "$ref": "#/components/schemas/BasicCorrelationIdentifier"
185
+ },
186
+ "connection": {
187
+ "$ref": "#/components/schemas/IBasicConnection"
188
+ },
189
+ "metadata": {
190
+ "type": "array",
191
+ "items": {
192
+ "$ref": "#/components/schemas/IMetadataItem"
193
+ }
194
+ },
195
+ "createdAt": {
196
+ "type": "string",
197
+ "format": "date-time"
198
+ },
199
+ "lastUpdatedAt": {
200
+ "type": "string",
201
+ "format": "date-time"
202
+ }
203
+ },
204
+ "required": ["id", "alias", "identifier", "createdAt", "lastUpdatedAt"]
205
+ },
206
+ "IIdentity": {
207
+ "type": "object",
208
+ "properties": {
209
+ "id": {
210
+ "type": "string"
211
+ },
212
+ "alias": {
213
+ "type": "string"
214
+ },
215
+ "identifier": {
216
+ "$ref": "#/components/schemas/ICorrelationIdentifier"
217
+ },
218
+ "connection": {
219
+ "$ref": "#/components/schemas/IConnection"
220
+ },
221
+ "metadata": {
222
+ "type": "array",
223
+ "items": {
224
+ "$ref": "#/components/schemas/IMetadataItem"
225
+ }
226
+ },
227
+ "createdAt": {
228
+ "type": "string",
229
+ "format": "date-time"
230
+ },
231
+ "lastUpdatedAt": {
232
+ "type": "string",
233
+ "format": "date-time"
234
+ }
235
+ },
236
+ "required": ["id", "alias", "identifier", "createdAt", "lastUpdatedAt"]
237
+ },
238
+ "CorrelationIdentifierEnum": {
239
+ "type": "string",
240
+ "enum": ["did", "url"]
241
+ },
242
+ "BasicCorrelationIdentifier": {
243
+ "type": "object",
244
+ "properties": {
245
+ "type": {
246
+ "$ref": "#/components/schemas/CorrelationIdentifierEnum"
247
+ },
248
+ "correlationId": {
249
+ "type": "string"
250
+ }
251
+ },
252
+ "required": ["type", "correlationId"]
253
+ },
254
+ "ICorrelationIdentifier": {
255
+ "type": "object",
256
+ "properties": {
257
+ "id": {
258
+ "type": "string"
259
+ },
260
+ "type": {
261
+ "$ref": "#/components/schemas/CorrelationIdentifierEnum"
262
+ },
263
+ "correlationId": {
264
+ "type": "string"
265
+ }
266
+ },
267
+ "required": ["id", "type", "correlationId"]
268
+ },
269
+ "ConnectionTypeEnum": {
270
+ "type": "string",
271
+ "enum": ["openid", "didauth", "siopv2+oidc4vp"]
272
+ },
273
+ "IBasicConnection": {
274
+ "type": "object",
275
+ "properties": {
276
+ "type": {
277
+ "$ref": "#/components/schemas/ConnectionTypeEnum"
278
+ },
279
+ "config": {
280
+ "$ref": "#/components/schemas/BasicConnectionConfig"
281
+ }
282
+ },
283
+ "required": ["type", "config"]
284
+ },
285
+ "IConnection": {
286
+ "type": "object",
287
+ "properties": {
288
+ "id": {
289
+ "type": "string"
290
+ },
291
+ "type": {
292
+ "$ref": "#/components/schemas/ConnectionTypeEnum"
293
+ },
294
+ "config": {
295
+ "$ref": "#/components/schemas/ConnectionConfig"
296
+ }
297
+ },
298
+ "required": ["id", "type", "config"]
299
+ },
300
+ "BasicConnectionConfig": {
301
+ "anyOf": [
302
+ {
303
+ "$ref": "#/components/schemas/BasicDidAuthConfig"
304
+ },
305
+ {
306
+ "$ref": "#/components/schemas/BasicOpenIdConfig"
307
+ }
308
+ ]
309
+ },
310
+ "ConnectionConfig": {
311
+ "anyOf": [
312
+ {
313
+ "$ref": "#/components/schemas/IOpenIdConfig"
314
+ },
315
+ {
316
+ "$ref": "#/components/schemas/IDidAuthConfig"
317
+ }
318
+ ]
319
+ },
320
+ "BasicDidAuthConfig": {
321
+ "type": "object",
322
+ "properties": {
323
+ "identifier": {
324
+ "$ref": "#/components/schemas/IIdentifier"
325
+ },
326
+ "stateId": {
327
+ "type": "string"
328
+ },
329
+ "redirectUrl": {
330
+ "type": "string"
331
+ },
332
+ "sessionId": {
333
+ "type": "string"
334
+ }
335
+ },
336
+ "required": ["identifier", "stateId", "redirectUrl", "sessionId"]
337
+ },
338
+ "BasicOpenIdConfig": {
339
+ "type": "object",
340
+ "properties": {
341
+ "clientId": {
342
+ "type": "string"
343
+ },
344
+ "clientSecret": {
345
+ "type": "string"
346
+ },
347
+ "scopes": {
348
+ "type": "array",
349
+ "items": {
350
+ "type": "string"
351
+ }
352
+ },
353
+ "issuer": {
354
+ "type": "string"
355
+ },
356
+ "redirectUrl": {
357
+ "type": "string"
358
+ },
359
+ "dangerouslyAllowInsecureHttpRequests": {
360
+ "type": "boolean"
361
+ },
362
+ "clientAuthMethod": {
363
+ "type": "string",
364
+ "enum": ["basic", "post"]
365
+ }
366
+ },
367
+ "required": ["clientId", "clientSecret", "scopes", "issuer", "redirectUrl", "dangerouslyAllowInsecureHttpRequests"]
368
+ },
369
+ "IOpenIdConfig": {
370
+ "type": "object",
371
+ "properties": {
372
+ "id": {
373
+ "type": "string"
374
+ },
375
+ "clientId": {
376
+ "type": "string"
377
+ },
378
+ "clientSecret": {
379
+ "type": "string"
380
+ },
381
+ "scopes": {
382
+ "type": "array",
383
+ "items": {
384
+ "type": "string"
385
+ }
386
+ },
387
+ "issuer": {
388
+ "type": "string"
389
+ },
390
+ "redirectUrl": {
391
+ "type": "string"
392
+ },
393
+ "dangerouslyAllowInsecureHttpRequests": {
394
+ "type": "boolean"
395
+ },
396
+ "clientAuthMethod": {
397
+ "type": "string",
398
+ "enum": ["basic", "post"]
399
+ }
400
+ },
401
+ "required": ["id", "clientId", "clientSecret", "scopes", "issuer", "redirectUrl", "dangerouslyAllowInsecureHttpRequests"]
402
+ },
403
+ "IDidAuthConfig": {
404
+ "type": "object",
405
+ "properties": {
406
+ "id": {
407
+ "type": "string"
408
+ },
409
+ "identifier": {
410
+ "$ref": "#/components/schemas/IIdentifier"
411
+ },
412
+ "stateId": {
413
+ "type": "string"
414
+ },
415
+ "redirectUrl": {
416
+ "type": "string"
417
+ },
418
+ "sessionId": {
419
+ "type": "string"
420
+ }
421
+ },
422
+ "required": ["id", "identifier", "stateId", "redirectUrl", "sessionId"]
423
+ },
424
+ "IIdentifier": {
425
+ "type": "object",
426
+ "properties": {
427
+ "did": {
428
+ "type": "string",
429
+ "description": "Decentralized identifier"
430
+ },
431
+ "alias": {
432
+ "type": "string",
433
+ "description": "Optional. Identifier alias. Can be used to reference an object in an external system"
434
+ },
435
+ "provider": {
436
+ "type": "string",
437
+ "description": "Identifier provider name"
438
+ },
439
+ "controllerKeyId": {
440
+ "type": "string",
441
+ "description": "Controller key id"
442
+ },
443
+ "keys": {
444
+ "type": "array",
445
+ "items": {
446
+ "$ref": "#/components/schemas/IKey"
447
+ },
448
+ "description": "Array of managed keys"
449
+ },
450
+ "services": {
451
+ "type": "array",
452
+ "items": {
453
+ "$ref": "#/components/schemas/IService"
454
+ },
455
+ "description": "Array of services"
456
+ }
457
+ },
458
+ "required": ["did", "provider", "keys", "services"],
459
+ "description": "Identifier interface"
460
+ },
461
+ "IKey": {
462
+ "type": "object",
463
+ "properties": {
464
+ "kid": {
465
+ "type": "string",
466
+ "description": "Key ID"
467
+ },
468
+ "kms": {
469
+ "type": "string",
470
+ "description": "Key Management System"
471
+ },
472
+ "type": {
473
+ "$ref": "#/components/schemas/TKeyType",
474
+ "description": "Key type"
475
+ },
476
+ "publicKeyHex": {
477
+ "type": "string",
478
+ "description": "Public key"
479
+ },
480
+ "privateKeyHex": {
481
+ "type": "string",
482
+ "description": "Optional. Private key"
483
+ },
484
+ "meta": {
485
+ "anyOf": [
486
+ {
487
+ "$ref": "#/components/schemas/KeyMetadata"
488
+ },
489
+ {
490
+ "type": "null"
491
+ }
492
+ ],
493
+ "description": "Optional. Key metadata. This should be used to determine which algorithms are supported."
494
+ }
495
+ },
496
+ "required": ["kid", "kms", "type", "publicKeyHex"],
497
+ "description": "Cryptographic key"
498
+ },
499
+ "TKeyType": {
500
+ "type": "string",
501
+ "enum": ["Ed25519", "Secp256k1", "Secp256r1", "X25519", "Bls12381G1", "Bls12381G2", "RSA"],
502
+ "description": "Cryptographic key type."
503
+ },
504
+ "KeyMetadata": {
505
+ "type": "object",
506
+ "properties": {
507
+ "algorithms": {
508
+ "type": "array",
509
+ "items": {
510
+ "type": "string"
511
+ }
512
+ }
513
+ },
514
+ "description": "This encapsulates data about a key.\n\nImplementations of {@link @veramo/key-manager#AbstractKeyManagementSystem | AbstractKeyManagementSystem } should populate this object, for each key, with the algorithms that can be performed using it.\n\nThis can also be used to add various tags to the keys under management."
515
+ },
516
+ "IService": {
517
+ "type": "object",
518
+ "properties": {
519
+ "id": {
520
+ "type": "string",
521
+ "description": "ID"
522
+ },
523
+ "type": {
524
+ "type": "string",
525
+ "description": "Service type"
526
+ },
527
+ "serviceEndpoint": {
528
+ "anyOf": [
529
+ {
530
+ "$ref": "#/components/schemas/IServiceEndpoint"
531
+ },
532
+ {
533
+ "type": "array",
534
+ "items": {
535
+ "$ref": "#/components/schemas/IServiceEndpoint"
536
+ }
537
+ }
538
+ ],
539
+ "description": "Endpoint URL"
540
+ },
541
+ "description": {
542
+ "type": "string",
543
+ "description": "Optional. Description"
544
+ }
545
+ },
546
+ "required": ["id", "type", "serviceEndpoint"],
547
+ "description": "Identifier service"
548
+ },
549
+ "IServiceEndpoint": {
550
+ "anyOf": [
551
+ {
552
+ "type": "string"
553
+ },
554
+ {
555
+ "type": "object"
556
+ }
557
+ ],
558
+ "description": "Represents a service endpoint URL or a map of URLs"
559
+ }
560
+ },
561
+ "methods": {
562
+ "cmGetContact": {
563
+ "description": "",
564
+ "arguments": {
565
+ "$ref": "#/components/schemas/IGetContactArgs"
566
+ },
567
+ "returnType": {
568
+ "$ref": "#/components/schemas/IContact"
569
+ }
570
+ },
571
+ "cmGetContacts": {
572
+ "description": "",
573
+ "arguments": {
574
+ "$ref": "#/components/schemas/IGetContactsArgs"
575
+ },
576
+ "returnType": {
577
+ "type": "array",
578
+ "items": {
579
+ "$ref": "#/components/schemas/IContact"
580
+ }
581
+ }
582
+ },
583
+ "cmAddContact": {
584
+ "description": "",
585
+ "arguments": {
586
+ "$ref": "#/components/schemas/IAddContactArgs"
587
+ },
588
+ "returnType": {
589
+ "$ref": "#/components/schemas/IContact"
590
+ }
591
+ },
592
+ "cmRemoveContact": {
593
+ "description": "",
594
+ "arguments": {
595
+ "$ref": "#/components/schemas/IRemoveContactArgs"
596
+ },
597
+ "returnType": {
598
+ "type": "boolean"
599
+ }
600
+ },
601
+ "cmUpdateContact": {
602
+ "description": "",
603
+ "arguments": {
604
+ "$ref": "#/components/schemas/IUpdateContactArgs"
605
+ },
606
+ "returnType": {
607
+ "$ref": "#/components/schemas/IContact"
608
+ }
609
+ },
610
+ "cmGetIdentity": {
611
+ "description": "",
612
+ "arguments": {
613
+ "$ref": "#/components/schemas/IGetIdentityArgs"
614
+ },
615
+ "returnType": {
616
+ "$ref": "#/components/schemas/IIdentity"
617
+ }
618
+ },
619
+ "cmGetIdentities": {
620
+ "description": "",
621
+ "arguments": {
622
+ "$ref": "#/components/schemas/IGetIdentitiesArgs"
623
+ },
624
+ "returnType": {
625
+ "type": "array",
626
+ "items": {
627
+ "$ref": "#/components/schemas/IIdentity"
628
+ }
629
+ }
630
+ },
631
+ "cmAddIdentity": {
632
+ "description": "",
633
+ "arguments": {
634
+ "$ref": "#/components/schemas/IAddIdentityArgs"
635
+ },
636
+ "returnType": {
637
+ "$ref": "#/components/schemas/IIdentity"
638
+ }
639
+ },
640
+ "cmRemoveIdentity": {
641
+ "description": "",
642
+ "arguments": {
643
+ "$ref": "#/components/schemas/IRemoveIdentityArgs"
644
+ },
645
+ "returnType": {
646
+ "type": "boolean"
647
+ }
648
+ },
649
+ "cmUpdateIdentity": {
650
+ "description": "",
651
+ "arguments": {
652
+ "$ref": "#/components/schemas/IUpdateConnectionArgs"
653
+ },
654
+ "returnType": {
655
+ "$ref": "#/components/schemas/IIdentity"
656
+ }
657
+ }
658
+ }
659
+ }
660
+ }
661
+ }