-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
release(1.6.0-RC2): merge release into main (#109)
- Loading branch information
Showing
15 changed files
with
528 additions
and
71 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
21 changes: 21 additions & 0 deletions
21
developer/02. Technical Integration/04. Credentials/00. Wallet Creation.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| ## Managed Identity Wallet | ||
|
|
||
| ### Wallet Creation | ||
|
|
||
| The wallet tenant per company is created as part of the dataspace registration. | ||
| This includes a didWeb. | ||
| The managed identity wallet is created and new credentials are issued by th portal. | ||
| A direct interface by the user is not provided. | ||
|
|
||
| <br> | ||
| <br> | ||
|
|
||
| ### Initial Credentials | ||
|
|
||
| Each dataspace participant will receive (as part of the registration process) 2 credential types | ||
|
|
||
| * bpn credential (signed by the operator) | ||
| * membership credential (signed by the operator) | ||
|
|
||
| <br> | ||
| <br> |
97 changes: 97 additions & 0 deletions
97
developer/02. Technical Integration/04. Credentials/01. Get UseCase Credential.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| ## Use Case Credentials | ||
|
|
||
| The use case participation page is created to enable data provider/consumer and solution providers to view their use case participation and to request the participation for new use cases. | ||
| The use case participation is a verified credential which is stored on the company wallet which generates trust and liability in the network. The company signing the framework agrees to the use case date sharing rules. | ||
|
|
||
| Functional Description: [here](/docs/06.%20Certificates/01.%20UseCase%20Participation.md) | ||
|
|
||
| <br> | ||
|
|
||
| ### Process Flow | ||
|
|
||
| <br> | ||
|
|
||
| <p align="center"> | ||
| <img width="700" alt="image" src="https://github.com/catenax-ng/tx-portal-assets/assets/94133633/87be492d-4b3c-4bd2-8801-6a69f3f1819a"> | ||
| </p> | ||
|
|
||
| <br> | ||
| <br> | ||
|
|
||
| ### Displaying available Credential Types | ||
|
|
||
| <br> | ||
| <img width="636" alt="image" src="https://github.com/catenax-ng/tx-portal-assets/assets/94133633/c5ded524-278e-4995-8013-3987a3af7938"> | ||
| <br> | ||
| <br> | ||
|
|
||
| The available credential types are fetched from the portal db company_ssi_details and verified_credential_external_type_use_case_detail_versions. | ||
| The api response (see below) automatically includes the "ssiDetailData" which include the actual acting user company credential status. (e.g. if the company has one or several credentials of the use case framework requested or active already, it will be shown/displayed in the "ssiDetailData" section) | ||
|
|
||
| ```diff | ||
| ! GET /api/administration/companydata/useCaseParticipation | ||
| ``` | ||
|
|
||
| <br> | ||
|
|
||
| Request Body | ||
|
|
||
| [ | ||
| { | ||
| "useCase": "string", | ||
| "description": "string", | ||
| "credentialType": "e.g. TRACEABILITY_FRAMEWORK", | ||
| "verifiedCredentials": [ | ||
| { | ||
| "externalDetailData": { | ||
| "id": "uuid", | ||
| "verifiedCredentialExternalTypeId": "e.g. TRACEABILITY_CREDENTIAL", | ||
| "version": "string", | ||
| "template": "string", | ||
| "validFrom": "date", | ||
| "expiry": "date" | ||
| }, | ||
| "ssiDetailData": { | ||
| "credentialId": "uuid", | ||
| "participationStatus": "e.g. PENDING", | ||
| "expiryDate": "uuid", | ||
| "document": { | ||
| "documentId": "uuid", | ||
| "documentName": "string" | ||
| } | ||
| } | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| <br> | ||
| <br> | ||
|
|
||
| ### Submit Credential request | ||
|
|
||
| As part of the credential request submission (which is only possible if there is no PENDING request for the credential and version existing yet) the signed framework agreement need to get submitted. | ||
|
|
||
| ```diff | ||
| ! POST /api/administration/companydata/useCaseParticipation | ||
| ``` | ||
|
|
||
| <br> | ||
|
|
||
| Request Body | ||
|
|
||
| { | ||
| "verifiedCredentialTypeId": "uuid from the GET call", | ||
| "credentialType": "string from the GET call", | ||
| "document": "document file (only pdf are allowed)" | ||
| } | ||
|
|
||
|
|
||
| For the documents only pdf documents are allowed till 1 MB | ||
|
|
||
|
|
||
| <br> | ||
| <br> | ||
|
|
||
|
|
||
|
|
Oops, something went wrong.