@cheqd/studio 3.3.0 → 3.4.0-develop.2
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.
- package/dist/app.d.ts.map +1 -1
- package/dist/app.js +7 -0
- package/dist/app.js.map +1 -1
- package/dist/controllers/api/accreditation.d.ts +227 -0
- package/dist/controllers/api/accreditation.d.ts.map +1 -0
- package/dist/controllers/api/accreditation.js +667 -0
- package/dist/controllers/api/accreditation.js.map +1 -0
- package/dist/controllers/validator/index.d.ts +1 -1
- package/dist/controllers/validator/index.d.ts.map +1 -1
- package/dist/controllers/validator/index.js +1 -1
- package/dist/controllers/validator/index.js.map +1 -1
- package/dist/helpers/helpers.d.ts +3 -0
- package/dist/helpers/helpers.d.ts.map +1 -1
- package/dist/helpers/helpers.js +17 -0
- package/dist/helpers/helpers.js.map +1 -1
- package/dist/middleware/auth/routes/api/accreditation-auth.d.ts +5 -0
- package/dist/middleware/auth/routes/api/accreditation-auth.d.ts.map +1 -0
- package/dist/middleware/auth/routes/api/accreditation-auth.js +21 -0
- package/dist/middleware/auth/routes/api/accreditation-auth.js.map +1 -0
- package/dist/middleware/authentication.d.ts.map +1 -1
- package/dist/middleware/authentication.js +2 -0
- package/dist/middleware/authentication.js.map +1 -1
- package/dist/services/api/accreditation.d.ts +11 -0
- package/dist/services/api/accreditation.d.ts.map +1 -0
- package/dist/services/api/accreditation.js +116 -0
- package/dist/services/api/accreditation.js.map +1 -0
- package/dist/services/api/credentials.d.ts +1 -1
- package/dist/services/api/credentials.d.ts.map +1 -1
- package/dist/services/api/credentials.js +10 -2
- package/dist/services/api/credentials.js.map +1 -1
- package/dist/services/connectors/resource.d.ts +22 -0
- package/dist/services/connectors/resource.d.ts.map +1 -0
- package/dist/services/connectors/resource.js +38 -0
- package/dist/services/connectors/resource.js.map +1 -0
- package/dist/services/w3c-credential.d.ts +1 -0
- package/dist/services/w3c-credential.d.ts.map +1 -1
- package/dist/services/w3c-credential.js +2 -0
- package/dist/services/w3c-credential.js.map +1 -1
- package/dist/static/swagger-api.json +616 -0
- package/dist/types/accreditation.d.ts +84 -0
- package/dist/types/accreditation.d.ts.map +1 -0
- package/dist/types/accreditation.js +23 -0
- package/dist/types/accreditation.js.map +1 -0
- package/dist/types/constants.d.ts.map +1 -1
- package/dist/types/constants.js +1 -1
- package/dist/types/constants.js.map +1 -1
- package/dist/types/credential.d.ts +10 -4
- package/dist/types/credential.d.ts.map +1 -1
- package/dist/types/credential.js +5 -1
- package/dist/types/credential.js.map +1 -1
- package/dist/types/swagger-api-types.d.ts +233 -0
- package/dist/types/swagger-api-types.d.ts.map +1 -1
- package/dist/types/swagger-api-types.js +233 -0
- package/dist/types/swagger-api-types.js.map +1 -1
- package/package.json +21 -21
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"w3c-credential.js","sourceRoot":"","sources":["../../src/services/w3c-credential.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAYhD,OAAO,EAAc,SAAS,EAAE,MAAM,YAAY,CAAC;AAGnD,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAEvD,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAWzD,wBAAwB;AACxB,MAAM,OAAO,4BAA6B,SAAQ,YAAY;IAC7D,MAAM,CAAS;IACf,iBAAiB,CAAoB;IACrC,IAAI,CAAqB;IACzB,UAAU,CAAc;IACxB,YAAY,CAAS;IACrB,cAAc,CAAU;IACxB,gBAAgB,CAA6B;IAC7C,EAAE,CAAU;IACZ,KAAK,CAAY;IACjB,UAAU,CAAuD;IACjE,UAAU,CAAU;
|
|
1
|
+
{"version":3,"file":"w3c-credential.js","sourceRoot":"","sources":["../../src/services/w3c-credential.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAYhD,OAAO,EAAc,SAAS,EAAE,MAAM,YAAY,CAAC;AAGnD,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAEvD,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAWzD,wBAAwB;AACxB,MAAM,OAAO,4BAA6B,SAAQ,YAAY;IAC7D,MAAM,CAAS;IACf,iBAAiB,CAAoB;IACrC,IAAI,CAAqB;IACzB,UAAU,CAAc;IACxB,YAAY,CAAS;IACrB,cAAc,CAAU;IACxB,gBAAgB,CAA6B;IAC7C,EAAE,CAAU;IACZ,KAAK,CAAY;IACjB,UAAU,CAAuD;IACjE,UAAU,CAAU;IACpB,UAAU,CAA0B;IAEpC,YAAY,YAAqC;QAChD,KAAK,EAAE,CAAC;QACR,IAAI,UAAgC,CAAC;QAErC,UAAU,GAAG,YAAoC,CAAC;QAClD,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE,CAAC;YACtC,UAAU,GAAG,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC;QAClD,CAAC;QAED,IAAI,CAAC,UAAU,CAAC,GAAG,UAAU,CAAC,UAAU,CAAC,CAAC;QAC1C,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC;QAC5B,IAAI,CAAC,iBAAiB,GAAG,UAAU,CAAC,iBAAiB,CAAC;QACtD,IAAI,CAAC,gBAAgB,GAAG,UAAU,CAAC,gBAAgB,CAAC;QACpD,IAAI,CAAC,MAAM,GAAG,OAAO,UAAU,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;QAC/F,IAAI,CAAC,YAAY,GAAG,UAAU,CAAC,YAAY,CAAC;QAC5C,IAAI,CAAC,KAAK,GAAI,UAA+B,CAAC,KAAK,CAAC;QACpD,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC,UAAU,CAAC;IACzC,CAAC;IAEM,gBAAgB,CAAC,GAAe;QACtC,MAAM,OAAO,GAAG,SAAS,CAAC,GAAG,CAAkB,CAAC;QAEhD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YAC1C,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;QACjE,CAAC;QACD,MAAM,UAAU,GAAG,OAAO,CAAC,EAAE,CAAC;QAC9B,uEAAuE;QACvE,eAAe;QACf,qBAAqB;QACrB,6BAA6B;QAC7B,UAAU,CAAC,MAAM,GAAG;YACnB,EAAE,EAAE,OAAO,CAAC,GAAa;SACzB,CAAC;QACF,UAAU,CAAC,YAAY,GAAG,IAAI,IAAI,CAAE,OAAO,CAAC,GAAc,GAAG,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC;QACjF,UAAU,CAAC,gBAAgB,GAAG,OAAO,CAAC,EAAE,CAAC,gBAAgB,CAAC;QAC1D,UAAU,CAAC,iBAAiB,CAAC,EAAE,GAAG,OAAO,CAAC,GAAa,CAAC;QACxD,UAAU,CAAC,KAAK,GAAG;YAClB,IAAI,EAAE,cAAc;YACpB,GAAG,EAAE,GAAG;SACR,CAAC;QACF,OAAO,UAAkC,CAAC;IAC3C,CAAC;IAEM,KAAK,CAAC,oBAAoB,CAAC,KAAuB;QACxD,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC5B,OAAO,IAAI,CAAC,WAAW,CACtB,WAAW,CAAC,WAAW,EACvB,6EAA6E,CAC7E,CAAC;QACH,CAAC;QACD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;QAC9C,MAAM,cAAc,GAAG,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QAC5D,MAAM,aAAa,GAAG,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC;QAC1D,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC;QAExB,IAAI,CAAC,cAAc,EAAE,CAAC;YACrB,OAAO,IAAI,CAAC,WAAW,CACtB,WAAW,CAAC,WAAW,EACvB,8EAA8E,CAC9E,CAAC;QACH,CAAC;QACD,IAAI,CAAC,aAAa,EAAE,CAAC;YACpB,OAAO,IAAI,CAAC,WAAW,CACtB,WAAW,CAAC,WAAW,EACvB,8EAA8E,CAC9E,CAAC;QACH,CAAC;QAED,qBAAqB;QACrB,MAAM,UAAU,GAAG,MAAM,KAAK,CAAC,oBAAoB,CAAC,GAAG,EAAE,cAAc,EAAE,aAAa,CAAC,CAAC;QACxF,gCAAgC;QAChC,IAAI,UAAU,CAAC,KAAK,EAAE,CAAC;YACtB,OAAO,IAAI,CAAC,WAAW,CACtB,WAAW,CAAC,WAAW,EACvB,gFAAgF,UAAU,CAAC,KAAK,EAAE,CAClG,CAAC;QACH,CAAC;QACD,kCAAkC;QAClC,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC;YAC1B,OAAO,IAAI,CAAC,WAAW,CACtB,WAAW,CAAC,WAAW,EACvB,gFAAgF,UAAU,CAAC,KAAK,EAAE,CAClG,CAAC;QACH,CAAC;QACD,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC,QAAQ,CAAC;QACtC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC,gBAAgB,EAAE,UAAU,CAAC;QAC1D,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC;IACxB,CAAC;IAEM,eAAe;QACrB,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YACtB,OAAO,KAAK,CAAC;QACd,CAAC;QACD,OAAO,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,SAAS,CAAC;IAC3C,CAAC;IAEM,KAAK,CAAC,cAAc,CAAC,KAAuB,EAAE,QAAwB;QAC5E,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC;QACxB,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QACnC,MAAM,iBAAiB,GAAyB,EAAE,CAAC;QAEnD,mBAAmB;QACnB,MAAM,gBAAgB,GAAG,MAAM,OAAO,CAAC,GAAG,CACzC,UAAU,EAAE,QAAQ,EAAE,iBAAiB,EAAE,GAAG,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE;YAChE,OAAO,MAAM,KAAK,CAAC,wBAAwB,CAC1C;gBACC,iBAAiB,EAAE,SAAS,CAAC,iBAAiB;gBAC9C,gBAAgB,EAAE,SAAS,CAAC,gBAAgB;gBAC5C,iBAAiB,EAAE,SAAS,CAAC,GAAG,CAAC;gBACjC,IAAI,EAAE,2DAA2D;aACrC,EAC7B,QAAQ,CACR,CAAC;QACH,CAAC,CAAC,IAAI,EAAE,CACR,CAAC;QACF,qBAAqB;QACrB,MAAM,OAAO,CAAC,GAAG,CAChB,gBAAgB,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;YACrC,6CAA6C;YAC7C,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,eAAe,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;YAC3E,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;gBAChC,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;gBACrC,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACjC,CAAC;QACF,CAAC,CAAC,CACF,CAAC;QACF,eAAe;QACf,IAAI,gBAAgB,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;YACrD,OAAO,IAAI,CAAC,WAAW,CACtB,WAAW,CAAC,WAAW,EACvB,mBAAmB,gBAAgB,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,EAC3E,iBAAiB,CACjB,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC;IACzC,CAAC;CACD"}
|
|
@@ -224,6 +224,13 @@
|
|
|
224
224
|
}
|
|
225
225
|
}
|
|
226
226
|
},
|
|
227
|
+
"connector": {
|
|
228
|
+
"type": "string",
|
|
229
|
+
"enum": [
|
|
230
|
+
"verida",
|
|
231
|
+
"resource"
|
|
232
|
+
]
|
|
233
|
+
},
|
|
227
234
|
"required": [
|
|
228
235
|
"issuerDid",
|
|
229
236
|
"subjectDid",
|
|
@@ -505,6 +512,307 @@
|
|
|
505
512
|
}
|
|
506
513
|
}
|
|
507
514
|
},
|
|
515
|
+
"AccreditationIssueRequest": {
|
|
516
|
+
"description": "Input fields for the creating a Verifiable Accreditation.",
|
|
517
|
+
"type": "object",
|
|
518
|
+
"additionalProperties": false,
|
|
519
|
+
"properties": {
|
|
520
|
+
"issuerDid": {
|
|
521
|
+
"description": "DID of the Verifiable Accreditation issuer. This needs to be a `did:cheqd` DID.",
|
|
522
|
+
"type": "string",
|
|
523
|
+
"example": "did:cheqd:testnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0"
|
|
524
|
+
},
|
|
525
|
+
"subjectDid": {
|
|
526
|
+
"description": "DID of the Verifiable Accreditation holder/subject. This needs to be a `did:cheqd` DID.",
|
|
527
|
+
"type": "string",
|
|
528
|
+
"example": "did:cheqd:testnet:z6MkhaXgBZDvotDkL5257faiztiGiC2QtKLGpbnnEGta2doK"
|
|
529
|
+
},
|
|
530
|
+
"schemas": {
|
|
531
|
+
"description": "The list of schemas the subject DID is accredited for.",
|
|
532
|
+
"type": "array",
|
|
533
|
+
"items": {
|
|
534
|
+
"$ref": "#/components/schemas/SchemaUrl"
|
|
535
|
+
}
|
|
536
|
+
},
|
|
537
|
+
"accreditationName": {
|
|
538
|
+
"description": "Unique name of the Verifiable Accreditation.",
|
|
539
|
+
"type": "string"
|
|
540
|
+
},
|
|
541
|
+
"attributes": {
|
|
542
|
+
"description": "JSON object containing the attributes to be included in the Accreditation.",
|
|
543
|
+
"type": "object"
|
|
544
|
+
},
|
|
545
|
+
"@context": {
|
|
546
|
+
"description": "Optional properties to be included in the `@context` property of the Accreditation.",
|
|
547
|
+
"type": "array",
|
|
548
|
+
"items": {
|
|
549
|
+
"type": "string"
|
|
550
|
+
},
|
|
551
|
+
"example": [
|
|
552
|
+
"https://schema.org/schema.jsonld",
|
|
553
|
+
"https://veramo.io/contexts/profile/v1"
|
|
554
|
+
]
|
|
555
|
+
},
|
|
556
|
+
"parentAccreditation": {
|
|
557
|
+
"description": "DID URL of the parent Verifiable Accreditation, required for accredit/attest operation.",
|
|
558
|
+
"type": "string"
|
|
559
|
+
},
|
|
560
|
+
"rootAuthorization": {
|
|
561
|
+
"description": "DID URL of the root Verifiable Accreditation, required for accredit/attest operation.",
|
|
562
|
+
"type": "string"
|
|
563
|
+
},
|
|
564
|
+
"trustFramework": {
|
|
565
|
+
"description": "Name or Type of the Trust Framework, required for authorize operation.",
|
|
566
|
+
"type": "string"
|
|
567
|
+
},
|
|
568
|
+
"trustFrameworkId": {
|
|
569
|
+
"description": "Url of the Trust Framework, required for authorize operation.",
|
|
570
|
+
"type": "string"
|
|
571
|
+
},
|
|
572
|
+
"type": {
|
|
573
|
+
"description": "Optional properties to be included in the `type` property of the Accreditation.",
|
|
574
|
+
"type": "array",
|
|
575
|
+
"items": {
|
|
576
|
+
"type": "string"
|
|
577
|
+
},
|
|
578
|
+
"example": [
|
|
579
|
+
"Person"
|
|
580
|
+
]
|
|
581
|
+
},
|
|
582
|
+
"expirationDate": {
|
|
583
|
+
"description": "Optional expiration date according to the <a href=https://www.w3.org/TR/vc-data-model/#expiration> VC Data Model specification</a>.",
|
|
584
|
+
"type": "string",
|
|
585
|
+
"format": "date-time",
|
|
586
|
+
"example": "2023-06-08T13:49:28.000Z"
|
|
587
|
+
},
|
|
588
|
+
"format": {
|
|
589
|
+
"description": "Format of the Verifiable Accreditation. Defaults to VC-JWT.",
|
|
590
|
+
"type": "string",
|
|
591
|
+
"enum": [
|
|
592
|
+
"jwt",
|
|
593
|
+
"jsonld"
|
|
594
|
+
],
|
|
595
|
+
"example": "jwt"
|
|
596
|
+
},
|
|
597
|
+
"credentialStatus": {
|
|
598
|
+
"description": "Optional `credentialStatus` properties for VC revocation or suspension. Takes `statusListName` and `statusListPurpose` as inputs.",
|
|
599
|
+
"type": "object",
|
|
600
|
+
"required": [
|
|
601
|
+
"statusPurpose",
|
|
602
|
+
"statusListName"
|
|
603
|
+
],
|
|
604
|
+
"properties": {
|
|
605
|
+
"statusPurpose": {
|
|
606
|
+
"type": "string",
|
|
607
|
+
"enum": [
|
|
608
|
+
"revocation",
|
|
609
|
+
"suspension"
|
|
610
|
+
]
|
|
611
|
+
},
|
|
612
|
+
"statusListName": {
|
|
613
|
+
"type": "string"
|
|
614
|
+
},
|
|
615
|
+
"statusListIndex": {
|
|
616
|
+
"type": "number"
|
|
617
|
+
},
|
|
618
|
+
"statusListVersion": {
|
|
619
|
+
"type": "string",
|
|
620
|
+
"format": "date-time"
|
|
621
|
+
},
|
|
622
|
+
"statusListRangeStart": {
|
|
623
|
+
"type": "number"
|
|
624
|
+
},
|
|
625
|
+
"statusListRangeEnd": {
|
|
626
|
+
"type": "number"
|
|
627
|
+
},
|
|
628
|
+
"indexNotIn": {
|
|
629
|
+
"type": "number"
|
|
630
|
+
}
|
|
631
|
+
},
|
|
632
|
+
"example": {
|
|
633
|
+
"statusPurpose": "revocation",
|
|
634
|
+
"statusListName": "employee-credentials"
|
|
635
|
+
}
|
|
636
|
+
},
|
|
637
|
+
"termsOfUse": {
|
|
638
|
+
"description": "Terms of use can be utilized by an issuer or a holder to communicate the terms under which a verifiable credential was issued.",
|
|
639
|
+
"type": "array",
|
|
640
|
+
"items": {
|
|
641
|
+
"type": "object",
|
|
642
|
+
"example": {
|
|
643
|
+
"type": "IssuerPolicy",
|
|
644
|
+
"id": "http://example.com/policies/credential/4",
|
|
645
|
+
"profile": "http://example.com/profiles/credential",
|
|
646
|
+
"prohibition": [
|
|
647
|
+
{
|
|
648
|
+
"assigner": "https://example.edu/issuers/14",
|
|
649
|
+
"assignee": "AllVerifiers",
|
|
650
|
+
"target": "http://example.edu/credentials/3732",
|
|
651
|
+
"action": [
|
|
652
|
+
"Archival"
|
|
653
|
+
]
|
|
654
|
+
}
|
|
655
|
+
]
|
|
656
|
+
}
|
|
657
|
+
}
|
|
658
|
+
},
|
|
659
|
+
"refreshService": {
|
|
660
|
+
"description": "RefreshService property MUST be one or more refresh services that provides enough information to the recipient's software such that the recipient can refresh the verifiable credential.",
|
|
661
|
+
"type": "array",
|
|
662
|
+
"items": {
|
|
663
|
+
"type": "object",
|
|
664
|
+
"example": {
|
|
665
|
+
"type": "ManualRefreshService2018",
|
|
666
|
+
"id": "https://example.edu/refresh/3732"
|
|
667
|
+
}
|
|
668
|
+
}
|
|
669
|
+
},
|
|
670
|
+
"evidence": {
|
|
671
|
+
"description": "Evidence property MUST be one or more evidence schemes providing enough information for a verifier to determine whether the evidence gathered by the issuer meets its confidence requirements for relying on the credential.",
|
|
672
|
+
"type": "array",
|
|
673
|
+
"items": {
|
|
674
|
+
"type": "object",
|
|
675
|
+
"example": {
|
|
676
|
+
"type": [
|
|
677
|
+
"DocumentVerification"
|
|
678
|
+
],
|
|
679
|
+
"id": "https://example.edu/evidence/f2aeec97-fc0d-42bf-8ca7-0548192d4231",
|
|
680
|
+
"verifier": "https://example.edu/issuers/14",
|
|
681
|
+
"evidenceDocument": "DriversLicense",
|
|
682
|
+
"subjectPresence": "Physical",
|
|
683
|
+
"documentPresence": "Physical",
|
|
684
|
+
"licenseNumber": "123AB4567"
|
|
685
|
+
}
|
|
686
|
+
}
|
|
687
|
+
}
|
|
688
|
+
},
|
|
689
|
+
"connector": {
|
|
690
|
+
"type": "string",
|
|
691
|
+
"enum": [
|
|
692
|
+
"verida",
|
|
693
|
+
"resource"
|
|
694
|
+
]
|
|
695
|
+
},
|
|
696
|
+
"required": [
|
|
697
|
+
"issuerDid",
|
|
698
|
+
"subjectDid",
|
|
699
|
+
"schemas",
|
|
700
|
+
"accreditationName"
|
|
701
|
+
],
|
|
702
|
+
"example": {
|
|
703
|
+
"issuerDid": "did:cheqd:testnet:7bf81a20-633c-4cc7-bc4a-5a45801005e0",
|
|
704
|
+
"subjectDid": "did:cheqd:testnet:2582fe17-9b25-45e4-8104-1cfca430f0c3",
|
|
705
|
+
"schemas": [
|
|
706
|
+
{
|
|
707
|
+
"type": "MuseumPassCredential",
|
|
708
|
+
"url": "https://resolver.cheqd.net/1.0/identifiers/did:cheqd:testnet:0a5b94d0-a417-48ed-a6f5-4abc9e95888d?resourceName=MuseumPassCredentialSchema&resourceType=JsonSchemaValidator2018"
|
|
709
|
+
}
|
|
710
|
+
],
|
|
711
|
+
"format": "jwt",
|
|
712
|
+
"accreditationName": "authorizeAccreditation",
|
|
713
|
+
"trustFramework": "https://learn.cheqd.io/governance/start",
|
|
714
|
+
"trustFrameworkId": "cheqd Governance Framework",
|
|
715
|
+
"parentAccreditation": "did:cheqd:testnet:15b74787-6e48-4fd5-8020-eab24e990578?resourceName=accreditAccreditation&resourceType=VerifiableAccreditationToAccredit",
|
|
716
|
+
"rootAuthorization": "did:cheqd:testnet:5RpEg66jhhbmASWPXJRWrA?resourceName=authorizeAccreditation&resourceType=VerifiableAuthorisationForTrustChain",
|
|
717
|
+
"credentialStatus": {
|
|
718
|
+
"statusPurpose": "revocation",
|
|
719
|
+
"statusListName": "employee-credentials",
|
|
720
|
+
"statusListIndex": 10
|
|
721
|
+
}
|
|
722
|
+
}
|
|
723
|
+
},
|
|
724
|
+
"AccreditationVerifyRequest": {
|
|
725
|
+
"type": "object",
|
|
726
|
+
"properties": {
|
|
727
|
+
"subjectDid": {
|
|
728
|
+
"description": "DID of the Verifiable Accreditation holder/subject. This needs to be a `did:key` DID.",
|
|
729
|
+
"type": "string",
|
|
730
|
+
"example": "did:cheqd:testnet:5efa5126-c070-420f-a9c2-d22ae6eefb92"
|
|
731
|
+
},
|
|
732
|
+
"didUrl": {
|
|
733
|
+
"description": "Verifiable Accreditation to be verified as a VC-JWT string or a JSON object.",
|
|
734
|
+
"type": "string",
|
|
735
|
+
"example": "did:cheqd:testnet:7c2b990c-3d05-4ebf-91af-f4f4d0091d2e?resourceName=cheqd-issuer-logo&resourceType=CredentialArtwork"
|
|
736
|
+
},
|
|
737
|
+
"did": {
|
|
738
|
+
"type": "string",
|
|
739
|
+
"example": "did:cheqd:testnet:7c2b990c-3d05-4ebf-91af-f4f4d0091d2e"
|
|
740
|
+
},
|
|
741
|
+
"resourceId": {
|
|
742
|
+
"type": "string",
|
|
743
|
+
"example": "398cee0a-efac-4643-9f4c-74c48c72a14b"
|
|
744
|
+
},
|
|
745
|
+
"resourceName": {
|
|
746
|
+
"type": "string",
|
|
747
|
+
"example": "cheqd-issuer-logo"
|
|
748
|
+
},
|
|
749
|
+
"resourceType": {
|
|
750
|
+
"type": "string",
|
|
751
|
+
"example": "CredentialArtwork"
|
|
752
|
+
},
|
|
753
|
+
"schemas": {
|
|
754
|
+
"description": "The list of schemas the subject DID is accredited for.",
|
|
755
|
+
"type": "array",
|
|
756
|
+
"items": {
|
|
757
|
+
"$ref": "#/components/schemas/SchemaUrl"
|
|
758
|
+
}
|
|
759
|
+
},
|
|
760
|
+
"policies": {
|
|
761
|
+
"description": "Custom verification policies to execute when verifying Accreditation.",
|
|
762
|
+
"type": "object",
|
|
763
|
+
"properties": {
|
|
764
|
+
"issuanceDate": {
|
|
765
|
+
"description": "Policy to skip the `issuanceDate` (`nbf`) timestamp check when set to `false`.",
|
|
766
|
+
"type": "boolean",
|
|
767
|
+
"default": true
|
|
768
|
+
},
|
|
769
|
+
"expirationDate": {
|
|
770
|
+
"description": "Policy to skip the `expirationDate` (`exp`) timestamp check when set to `false`.",
|
|
771
|
+
"type": "boolean",
|
|
772
|
+
"default": true
|
|
773
|
+
},
|
|
774
|
+
"audience": {
|
|
775
|
+
"description": "Policy to skip the audience check when set to `false`.",
|
|
776
|
+
"type": "boolean",
|
|
777
|
+
"default": false
|
|
778
|
+
}
|
|
779
|
+
}
|
|
780
|
+
}
|
|
781
|
+
},
|
|
782
|
+
"required": [
|
|
783
|
+
"subjectDid"
|
|
784
|
+
]
|
|
785
|
+
},
|
|
786
|
+
"AccreditationRevokeRequest": {
|
|
787
|
+
"type": "object",
|
|
788
|
+
"properties": {
|
|
789
|
+
"didUrl": {
|
|
790
|
+
"description": "Verifiable Accreditation to be verified as a VC-JWT string or a JSON object.",
|
|
791
|
+
"type": "string",
|
|
792
|
+
"example": "did:cheqd:testnet:7c2b990c-3d05-4ebf-91af-f4f4d0091d2e?resourceName=cheqd-issuer-logo&resourceType=CredentialArtwork"
|
|
793
|
+
},
|
|
794
|
+
"did": {
|
|
795
|
+
"type": "string",
|
|
796
|
+
"example": "did:cheqd:testnet:7c2b990c-3d05-4ebf-91af-f4f4d0091d2e"
|
|
797
|
+
},
|
|
798
|
+
"resourceId": {
|
|
799
|
+
"type": "string",
|
|
800
|
+
"example": "398cee0a-efac-4643-9f4c-74c48c72a14b"
|
|
801
|
+
},
|
|
802
|
+
"resourceName": {
|
|
803
|
+
"type": "string",
|
|
804
|
+
"example": "cheqd-issuer-logo"
|
|
805
|
+
},
|
|
806
|
+
"resourceType": {
|
|
807
|
+
"type": "string",
|
|
808
|
+
"example": "CredentialArtwork"
|
|
809
|
+
},
|
|
810
|
+
"symmetricKey": {
|
|
811
|
+
"description": "The symmetric key used to encrypt the StatusList2021 DID-Linked Resource. Required if the StatusList2021 DID-Linked Resource is encrypted.",
|
|
812
|
+
"type": "string"
|
|
813
|
+
}
|
|
814
|
+
}
|
|
815
|
+
},
|
|
508
816
|
"PresentationCreateRequest": {
|
|
509
817
|
"type": "object",
|
|
510
818
|
"required": [
|
|
@@ -2042,6 +2350,17 @@
|
|
|
2042
2350
|
}
|
|
2043
2351
|
}
|
|
2044
2352
|
},
|
|
2353
|
+
"SchemaUrl": {
|
|
2354
|
+
"type": "object",
|
|
2355
|
+
"properties": {
|
|
2356
|
+
"type": {
|
|
2357
|
+
"type": "string"
|
|
2358
|
+
},
|
|
2359
|
+
"url": {
|
|
2360
|
+
"type": "string"
|
|
2361
|
+
}
|
|
2362
|
+
}
|
|
2363
|
+
},
|
|
2045
2364
|
"InvalidRequest": {
|
|
2046
2365
|
"description": "A problem with the input fields has occurred. Additional state information plus metadata may be available in the response body.",
|
|
2047
2366
|
"type": "object",
|
|
@@ -2185,6 +2504,303 @@
|
|
|
2185
2504
|
}
|
|
2186
2505
|
}
|
|
2187
2506
|
},
|
|
2507
|
+
"/trust-registry/accreditation/issue": {
|
|
2508
|
+
"post": {
|
|
2509
|
+
"tags": [
|
|
2510
|
+
"Trust Registry"
|
|
2511
|
+
],
|
|
2512
|
+
"summary": "Publish a verifiable accreditation for a DID.",
|
|
2513
|
+
"description": "Generate and publish a Verifiable Accreditation for a subject DID as a DID Linked resource.",
|
|
2514
|
+
"operationId": "accredit-issue",
|
|
2515
|
+
"parameters": [
|
|
2516
|
+
{
|
|
2517
|
+
"in": "query",
|
|
2518
|
+
"name": "accreditationType",
|
|
2519
|
+
"description": "Select the type of accreditation to be issued.",
|
|
2520
|
+
"schema": {
|
|
2521
|
+
"type": "string",
|
|
2522
|
+
"enum": [
|
|
2523
|
+
"authorize",
|
|
2524
|
+
"accredit",
|
|
2525
|
+
"attest"
|
|
2526
|
+
]
|
|
2527
|
+
},
|
|
2528
|
+
"required": true
|
|
2529
|
+
}
|
|
2530
|
+
],
|
|
2531
|
+
"requestBody": {
|
|
2532
|
+
"content": {
|
|
2533
|
+
"application/x-www-form-urlencoded": {
|
|
2534
|
+
"schema": {
|
|
2535
|
+
"$ref": "#/components/schemas/AccreditationIssueRequest"
|
|
2536
|
+
}
|
|
2537
|
+
},
|
|
2538
|
+
"application/json": {
|
|
2539
|
+
"schema": {
|
|
2540
|
+
"$ref": "#/components/schemas/AccreditationIssueRequest"
|
|
2541
|
+
}
|
|
2542
|
+
}
|
|
2543
|
+
}
|
|
2544
|
+
},
|
|
2545
|
+
"responses": {
|
|
2546
|
+
"200": {
|
|
2547
|
+
"description": "The request was successful.",
|
|
2548
|
+
"content": {
|
|
2549
|
+
"application/json": {
|
|
2550
|
+
"schema": {
|
|
2551
|
+
"$ref": "#/components/schemas/Credential"
|
|
2552
|
+
}
|
|
2553
|
+
}
|
|
2554
|
+
}
|
|
2555
|
+
},
|
|
2556
|
+
"400": {
|
|
2557
|
+
"$ref": "#/components/schemas/InvalidRequest"
|
|
2558
|
+
},
|
|
2559
|
+
"401": {
|
|
2560
|
+
"$ref": "#/components/schemas/UnauthorizedError"
|
|
2561
|
+
},
|
|
2562
|
+
"500": {
|
|
2563
|
+
"$ref": "#/components/schemas/InternalError"
|
|
2564
|
+
}
|
|
2565
|
+
}
|
|
2566
|
+
}
|
|
2567
|
+
},
|
|
2568
|
+
"/trust-registry/accreditation/verify": {
|
|
2569
|
+
"post": {
|
|
2570
|
+
"tags": [
|
|
2571
|
+
"Trust Registry"
|
|
2572
|
+
],
|
|
2573
|
+
"summary": "Verify a verifiable accreditation for a DID.",
|
|
2574
|
+
"description": "Generate and publish a Verifiable Accreditation for a subject DID as a DID Linked resource.",
|
|
2575
|
+
"operationId": "accredit-verify",
|
|
2576
|
+
"parameters": [
|
|
2577
|
+
{
|
|
2578
|
+
"in": "query",
|
|
2579
|
+
"name": "verifyStatus",
|
|
2580
|
+
"description": "If set to `true` the verification will also check the status of the accreditation. Requires the VC to have a `credentialStatus` property.",
|
|
2581
|
+
"schema": {
|
|
2582
|
+
"type": "boolean",
|
|
2583
|
+
"default": false
|
|
2584
|
+
}
|
|
2585
|
+
},
|
|
2586
|
+
{
|
|
2587
|
+
"in": "query",
|
|
2588
|
+
"name": "allowDeactivatedDid",
|
|
2589
|
+
"description": "If set to `true` allow to verify accreditation which based on deactivated DID.",
|
|
2590
|
+
"schema": {
|
|
2591
|
+
"type": "boolean",
|
|
2592
|
+
"default": false
|
|
2593
|
+
}
|
|
2594
|
+
}
|
|
2595
|
+
],
|
|
2596
|
+
"requestBody": {
|
|
2597
|
+
"content": {
|
|
2598
|
+
"application/x-www-form-urlencoded": {
|
|
2599
|
+
"schema": {
|
|
2600
|
+
"$ref": "#/components/schemas/AccreditationVerifyRequest"
|
|
2601
|
+
}
|
|
2602
|
+
},
|
|
2603
|
+
"application/json": {
|
|
2604
|
+
"schema": {
|
|
2605
|
+
"$ref": "#/components/schemas/AccreditationVerifyRequest"
|
|
2606
|
+
}
|
|
2607
|
+
}
|
|
2608
|
+
}
|
|
2609
|
+
},
|
|
2610
|
+
"responses": {
|
|
2611
|
+
"200": {
|
|
2612
|
+
"description": "The request was successful.",
|
|
2613
|
+
"content": {
|
|
2614
|
+
"application/json": {
|
|
2615
|
+
"schema": {
|
|
2616
|
+
"$ref": "#/components/schemas/Credential"
|
|
2617
|
+
}
|
|
2618
|
+
}
|
|
2619
|
+
}
|
|
2620
|
+
},
|
|
2621
|
+
"400": {
|
|
2622
|
+
"$ref": "#/components/schemas/InvalidRequest"
|
|
2623
|
+
},
|
|
2624
|
+
"401": {
|
|
2625
|
+
"$ref": "#/components/schemas/UnauthorizedError"
|
|
2626
|
+
},
|
|
2627
|
+
"500": {
|
|
2628
|
+
"$ref": "#/components/schemas/InternalError"
|
|
2629
|
+
}
|
|
2630
|
+
}
|
|
2631
|
+
}
|
|
2632
|
+
},
|
|
2633
|
+
"/trust-registry/accreditation/revoke": {
|
|
2634
|
+
"post": {
|
|
2635
|
+
"tags": [
|
|
2636
|
+
"Trust Registry"
|
|
2637
|
+
],
|
|
2638
|
+
"summary": "Revoke a Verifiable Accreditation.",
|
|
2639
|
+
"description": "This endpoint revokes a given Verifiable Accreditation. As input, it can take the didUrl as a string. The StatusList2021 resource should already be setup in the VC and `credentialStatus` property present in the VC.",
|
|
2640
|
+
"operationId": "accredit-revoke",
|
|
2641
|
+
"parameters": [
|
|
2642
|
+
{
|
|
2643
|
+
"in": "query",
|
|
2644
|
+
"name": "publish",
|
|
2645
|
+
"description": "Set whether the StatusList2021 resource should be published to the ledger or not. If set to `false`, the StatusList2021 publisher should manually publish the resource.",
|
|
2646
|
+
"required": true,
|
|
2647
|
+
"schema": {
|
|
2648
|
+
"type": "boolean",
|
|
2649
|
+
"default": true
|
|
2650
|
+
}
|
|
2651
|
+
}
|
|
2652
|
+
],
|
|
2653
|
+
"requestBody": {
|
|
2654
|
+
"content": {
|
|
2655
|
+
"application/x-www-form-urlencoded": {
|
|
2656
|
+
"schema": {
|
|
2657
|
+
"$ref": "#/components/schemas/AccreditationRevokeRequest"
|
|
2658
|
+
}
|
|
2659
|
+
},
|
|
2660
|
+
"application/json": {
|
|
2661
|
+
"schema": {
|
|
2662
|
+
"$ref": "#/components/schemas/AccreditationRevokeRequest"
|
|
2663
|
+
}
|
|
2664
|
+
}
|
|
2665
|
+
}
|
|
2666
|
+
},
|
|
2667
|
+
"responses": {
|
|
2668
|
+
"200": {
|
|
2669
|
+
"description": "The request was successful.",
|
|
2670
|
+
"content": {
|
|
2671
|
+
"application/json": {
|
|
2672
|
+
"schema": {
|
|
2673
|
+
"$ref": "#/components/schemas/RevocationResult"
|
|
2674
|
+
}
|
|
2675
|
+
}
|
|
2676
|
+
}
|
|
2677
|
+
},
|
|
2678
|
+
"400": {
|
|
2679
|
+
"$ref": "#/components/schemas/InvalidRequest"
|
|
2680
|
+
},
|
|
2681
|
+
"401": {
|
|
2682
|
+
"$ref": "#/components/schemas/UnauthorizedError"
|
|
2683
|
+
},
|
|
2684
|
+
"500": {
|
|
2685
|
+
"$ref": "#/components/schemas/InternalError"
|
|
2686
|
+
}
|
|
2687
|
+
}
|
|
2688
|
+
}
|
|
2689
|
+
},
|
|
2690
|
+
"/trust-registry/accreditation/suspend": {
|
|
2691
|
+
"post": {
|
|
2692
|
+
"tags": [
|
|
2693
|
+
"Trust Registry"
|
|
2694
|
+
],
|
|
2695
|
+
"summary": "Suspend a Verifiable Accreditation.",
|
|
2696
|
+
"description": "This endpoint suspends a given Verifiable Accreditation. As input, it can take the didUrl as a string. The StatusList2021 resource should already be setup in the VC and `credentialStatus` property present in the VC.",
|
|
2697
|
+
"operationId": "accredit-suspend",
|
|
2698
|
+
"parameters": [
|
|
2699
|
+
{
|
|
2700
|
+
"in": "query",
|
|
2701
|
+
"name": "publish",
|
|
2702
|
+
"description": "Set whether the StatusList2021 resource should be published to the ledger or not. If set to `false`, the StatusList2021 publisher should manually publish the resource.",
|
|
2703
|
+
"required": true,
|
|
2704
|
+
"schema": {
|
|
2705
|
+
"type": "boolean",
|
|
2706
|
+
"default": true
|
|
2707
|
+
}
|
|
2708
|
+
}
|
|
2709
|
+
],
|
|
2710
|
+
"requestBody": {
|
|
2711
|
+
"content": {
|
|
2712
|
+
"application/x-www-form-urlencoded": {
|
|
2713
|
+
"schema": {
|
|
2714
|
+
"$ref": "#/components/schemas/AccreditationRevokeRequest"
|
|
2715
|
+
}
|
|
2716
|
+
},
|
|
2717
|
+
"application/json": {
|
|
2718
|
+
"schema": {
|
|
2719
|
+
"$ref": "#/components/schemas/AccreditationRevokeRequest"
|
|
2720
|
+
}
|
|
2721
|
+
}
|
|
2722
|
+
}
|
|
2723
|
+
},
|
|
2724
|
+
"responses": {
|
|
2725
|
+
"200": {
|
|
2726
|
+
"description": "The request was successful.",
|
|
2727
|
+
"content": {
|
|
2728
|
+
"application/json": {
|
|
2729
|
+
"schema": {
|
|
2730
|
+
"$ref": "#/components/schemas/RevocationResult"
|
|
2731
|
+
}
|
|
2732
|
+
}
|
|
2733
|
+
}
|
|
2734
|
+
},
|
|
2735
|
+
"400": {
|
|
2736
|
+
"$ref": "#/components/schemas/InvalidRequest"
|
|
2737
|
+
},
|
|
2738
|
+
"401": {
|
|
2739
|
+
"$ref": "#/components/schemas/UnauthorizedError"
|
|
2740
|
+
},
|
|
2741
|
+
"500": {
|
|
2742
|
+
"$ref": "#/components/schemas/InternalError"
|
|
2743
|
+
}
|
|
2744
|
+
}
|
|
2745
|
+
}
|
|
2746
|
+
},
|
|
2747
|
+
"/trust-registry/accreditation/reinstate": {
|
|
2748
|
+
"post": {
|
|
2749
|
+
"tags": [
|
|
2750
|
+
"Trust Registry"
|
|
2751
|
+
],
|
|
2752
|
+
"summary": "Reinstate a Verifiable Accreditation.",
|
|
2753
|
+
"description": "This endpoint reinstates a given Verifiable Accreditation. As input, it can take the didUrl as a string. The StatusList2021 resource should already be setup in the VC and `credentialStatus` property present in the VC.",
|
|
2754
|
+
"operationId": "accredit-reinstate",
|
|
2755
|
+
"parameters": [
|
|
2756
|
+
{
|
|
2757
|
+
"in": "query",
|
|
2758
|
+
"name": "publish",
|
|
2759
|
+
"description": "Set whether the StatusList2021 resource should be published to the ledger or not. If set to `false`, the StatusList2021 publisher should manually publish the resource.",
|
|
2760
|
+
"required": true,
|
|
2761
|
+
"schema": {
|
|
2762
|
+
"type": "boolean",
|
|
2763
|
+
"default": true
|
|
2764
|
+
}
|
|
2765
|
+
}
|
|
2766
|
+
],
|
|
2767
|
+
"requestBody": {
|
|
2768
|
+
"content": {
|
|
2769
|
+
"application/x-www-form-urlencoded": {
|
|
2770
|
+
"schema": {
|
|
2771
|
+
"$ref": "#/components/schemas/AccreditationRevokeRequest"
|
|
2772
|
+
}
|
|
2773
|
+
},
|
|
2774
|
+
"application/json": {
|
|
2775
|
+
"schema": {
|
|
2776
|
+
"$ref": "#/components/schemas/AccreditationRevokeRequest"
|
|
2777
|
+
}
|
|
2778
|
+
}
|
|
2779
|
+
}
|
|
2780
|
+
},
|
|
2781
|
+
"responses": {
|
|
2782
|
+
"200": {
|
|
2783
|
+
"description": "The request was successful.",
|
|
2784
|
+
"content": {
|
|
2785
|
+
"application/json": {
|
|
2786
|
+
"schema": {
|
|
2787
|
+
"$ref": "#/components/schemas/RevocationResult"
|
|
2788
|
+
}
|
|
2789
|
+
}
|
|
2790
|
+
}
|
|
2791
|
+
},
|
|
2792
|
+
"400": {
|
|
2793
|
+
"$ref": "#/components/schemas/InvalidRequest"
|
|
2794
|
+
},
|
|
2795
|
+
"401": {
|
|
2796
|
+
"$ref": "#/components/schemas/UnauthorizedError"
|
|
2797
|
+
},
|
|
2798
|
+
"500": {
|
|
2799
|
+
"$ref": "#/components/schemas/InternalError"
|
|
2800
|
+
}
|
|
2801
|
+
}
|
|
2802
|
+
}
|
|
2803
|
+
},
|
|
2188
2804
|
"/credential-status/create/unencrypted": {
|
|
2189
2805
|
"post": {
|
|
2190
2806
|
"tags": [
|