diff --git a/documentation/Gaia-X Organization Credential Manager.postman_collection.json b/documentation/Gaia-X Organization Credential Manager.postman_collection.json
index 7c4ebfed981e26d7e89e9f2ac9ac267800468c9b..3c289d3606862037ada666b085d608c80d69dbe0 100644
--- a/documentation/Gaia-X Organization Credential Manager.postman_collection.json
+++ b/documentation/Gaia-X Organization Credential Manager.postman_collection.json
@@ -2,7 +2,7 @@
"info": {
"_postman_id": "ab160828-a6d8-4f4c-a730-eaeaf5ba3754",
"name": "Gaia-X Organization Credential Manager",
- "description": "## Overview\n\nOCM (Organizational Credential Manager) is a Node.js-based microservice system designed to manage organizational credentials.\n\n## Quick Start\n\n### Clone the repository:\n\n``` bash\ngit clone -b chore/e2e git@gitlab.eclipse.org:tsabolov/ocm-engine.git\n\n ```\n\n### Start the stack using `docker-compose up -d` in the root of the project:\n\n``` bash\ncd ocm-engine\ndocker compose up -d\n\n ```\n\n> **Note:** By default, this collection is configured to interact with services running locally (using Docker Compose or directly on the bare metal). If you wish to run the requests of this collection against the OCM stack hosted on a remote machine, you will need to create a new Postman Environment. Within this environment, specify the base URLs for each of the services and DevTools as follows: \n \n\n### Initial Setup\n\nIn the \"Integration\" folder, execute all requests under the `Init` subfolder one-by-one. These are needed to \"seed\" the stack with some initial data and actors (tenants).\n\n> You can use Postman's feature `Run Folder` for this. \n \n\nOnce the `Init` step is done, execute the steps in the following folders in the order they are defined.\n\n## Known Issues\n\nAs of the current time, the following flows are known to be broken. We are aware of these issues and are working on resolving them:\n\n- Self-Issuance\n- Issuance of a credential with revocation support, and therefore revocation\n \n\nIf you encounter any other issues, please let us know.",
+ "description": "## Overview\n\nOCM (Organizational Credential Manager) is a Node.js-based microservice system designed to manage organizational credentials.\n\n## Quick Start\n\n### Clone the repository:\n\n``` bash\ngit clone git@gitlab.eclipse.org:eclipse/xfsc/ocm/ocm-engine.git\n\n ```\n\n### Start the stack using `docker-compose up -d` in the root of the project:\n\n``` bash\ncd ocm-engine\ndocker compose up -d\n\n ```\n\n> **Note:** By default, this collection is configured to interact with services running locally (using Docker Compose or directly on the bare metal). If you wish to run the requests of this collection against the OCM stack hosted on a remote machine, you will need to create a new Postman Environment. \n \n\n### Initial Setup\n\nIn the \"Integration\" folder, execute all requests under the `Init` subfolder one-by-one. These are needed to \"seed\" the stack with some initial data and actors (tenants).\n\n> You can use Postman's feature `Run Folder` for this. \n \n\nOnce the `Init` step is done, execute the steps in the following folders in the order they are defined.",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"_exporter_id": "14427538"
},
@@ -29,6 +29,137 @@
{
"name": "DID Manager",
"item": []
+ },
+ {
+ "name": "Tenant Manager",
+ "item": [
+ {
+ "name": "v1",
+ "item": [
+ {
+ "name": "tenants",
+ "item": [
+ {
+ "name": "Tenants Controller find",
+ "request": {
+ "method": "GET",
+ "header": [],
+ "url": {
+ "raw": "{{Tenant Manager Base URL}}/v1/tenants",
+ "host": [
+ "{{Tenant Manager Base URL}}"
+ ],
+ "path": [
+ "v1",
+ "tenants"
+ ]
+ }
+ },
+ "response": [
+ {
+ "name": "Get all tenant IDs",
+ "originalRequest": {
+ "method": "GET",
+ "header": [],
+ "url": {
+ "raw": "{{baseUrl}}/v1/tenants",
+ "host": [
+ "{{baseUrl}}"
+ ],
+ "path": [
+ "v1",
+ "tenants"
+ ]
+ }
+ },
+ "status": "OK",
+ "code": 200,
+ "_postman_previewlanguage": "text",
+ "header": [],
+ "cookie": [],
+ "body": ""
+ }
+ ]
+ },
+ {
+ "name": "Tenants Controller create",
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "raw": "{\n \"label\": \"\"\n}",
+ "options": {
+ "raw": {
+ "headerFamily": "json",
+ "language": "json"
+ }
+ }
+ },
+ "url": {
+ "raw": "{{Tenant Manager Base URL}}/v1/tenants",
+ "host": [
+ "{{Tenant Manager Base URL}}"
+ ],
+ "path": [
+ "v1",
+ "tenants"
+ ]
+ }
+ },
+ "response": [
+ {
+ "name": "Create 'Alice' tenant",
+ "originalRequest": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "value": "application/json"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "raw": "{\n \"label\": \"Alice\"\n}",
+ "options": {
+ "raw": {
+ "headerFamily": "json",
+ "language": "json"
+ }
+ }
+ },
+ "url": {
+ "raw": "http://localhost:4007/v1/tenants",
+ "protocol": "http",
+ "host": [
+ "localhost"
+ ],
+ "port": "4007",
+ "path": [
+ "v1",
+ "tenants"
+ ]
+ }
+ },
+ "status": "Created",
+ "code": 201,
+ "_postman_previewlanguage": "text",
+ "header": [],
+ "cookie": [],
+ "body": ""
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ ]
}
],
"description": "This folder contains the documentation for the individual microservices of the Organization Credential Manager (OCM)"
@@ -39,36 +170,6 @@
{
"name": "Init",
"item": [
- {
- "name": "Register Endorser DID",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "pm.test(\"Status code is 201\", function () {",
- " pm.response.to.have.status(201);",
- "});"
- ],
- "type": "text/javascript"
- }
- }
- ],
- "request": {
- "method": "POST",
- "header": [],
- "url": {
- "raw": "{{DevTools Base URL}}/register-endorser-did",
- "host": [
- "{{DevTools Base URL}}"
- ],
- "path": [
- "register-endorser-did"
- ]
- }
- },
- "response": []
- },
{
"name": "Create 'issuer' tenant",
"event": [
@@ -81,7 +182,7 @@
"});",
"",
"const json = pm.response.json();",
- "pm.collectionVariables.set(\"issuer_id\", json.id);"
+ "pm.collectionVariables.set(\"issuer_id\", json.data.id);"
],
"type": "text/javascript"
}
@@ -100,12 +201,13 @@
}
},
"url": {
- "raw": "{{DevTools Base URL}}/create-tenant",
+ "raw": "{{Tenant Manager Base URL}}/v1/tenants",
"host": [
- "{{DevTools Base URL}}"
+ "{{Tenant Manager Base URL}}"
],
"path": [
- "create-tenant"
+ "v1",
+ "tenants"
]
}
},
@@ -123,7 +225,7 @@
"});",
"",
"const json = pm.response.json();",
- "pm.collectionVariables.set(\"holder_id\", json.id);"
+ "pm.collectionVariables.set(\"holder_id\", json.data.id);"
],
"type": "text/javascript"
}
@@ -142,12 +244,13 @@
}
},
"url": {
- "raw": "{{DevTools Base URL}}/create-tenant",
+ "raw": "{{Tenant Manager Base URL}}/v1/tenants",
"host": [
- "{{DevTools Base URL}}"
+ "{{Tenant Manager Base URL}}"
],
"path": [
- "create-tenant"
+ "v1",
+ "tenants"
]
}
},
@@ -165,7 +268,7 @@
"});",
"",
"const json = pm.response.json();",
- "pm.collectionVariables.set(\"verifier_id\", json.id);"
+ "pm.collectionVariables.set(\"verifier_id\", json.data.id);"
],
"type": "text/javascript"
}
@@ -184,12 +287,13 @@
}
},
"url": {
- "raw": "{{DevTools Base URL}}/create-tenant",
+ "raw": "{{Tenant Manager Base URL}}/v1/tenants",
"host": [
- "{{DevTools Base URL}}"
+ "{{Tenant Manager Base URL}}"
],
"path": [
- "create-tenant"
+ "v1",
+ "tenants"
]
}
},
@@ -227,7 +331,7 @@
"header": [],
"body": {
"mode": "raw",
- "raw": "{\n \"seed\": \"{{$randomPassword}}{{$randomAlphaNumeric}}{{$randomAlphaNumeric}}{{$randomPassword}}\"\n}",
+ "raw": "{\n \"seed\": \"{{$randomPassword}}{{$randomAlphaNumeric}}{{$randomAlphaNumeric}}{{$randomPassword}}\",\n \"services\": [\n {\n \"id\": \"#endpoint\",\n \"type\": \"endpoint\",\n \"serviceEndpoint\": \"https://bar.example.com\"\n },\n {\n \"id\": \"#didcomm-messaging\",\n \"type\": \"didcomm-messaging\",\n \"serviceEndpoint\": \"https://bar.example.com\"\n },\n {\n \"id\": \"#did-communication\",\n \"type\": \"did-communication\",\n \"serviceEndpoint\": \"https://bar.example.com\"\n },\n {\n \"id\": \"#DIDComm\",\n \"type\": \"DIDComm\",\n \"serviceEndpoint\": \"https://bar.example.com\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
@@ -260,7 +364,7 @@
"header": [],
"body": {
"mode": "raw",
- "raw": "{\n \"domain\": \"\",\n \"expiryTime\": 1\n}",
+ "raw": "{\n \"domain\": \"https://did.spherity.com\",\n \"expiryTime\": 1800\n}",
"options": {
"raw": {
"language": "json"
@@ -286,9 +390,40 @@
}
},
"response": []
+ },
+ {
+ "name": "Resolve 'issuer' DID",
+ "request": {
+ "method": "GET",
+ "header": [],
+ "url": {
+ "raw": "{{DID Manager Base URL}}/v1/dids/:did?tenantId={{issuer_id}}",
+ "host": [
+ "{{DID Manager Base URL}}"
+ ],
+ "path": [
+ "v1",
+ "dids",
+ ":did"
+ ],
+ "query": [
+ {
+ "key": "tenantId",
+ "value": "{{issuer_id}}"
+ }
+ ],
+ "variable": [
+ {
+ "key": "did",
+ "value": "{{issuer_did}}"
+ }
+ ]
+ }
+ },
+ "response": []
}
],
- "description": "This folder contains a series of preliminary requests essential for execution before proceeding with the rest of the integration tests:\n\n- Register the Endorser DID.\n \n- Create a tenant named 'issuer'.\n \n- Create a tenant named 'holder'.\n \n- Create a tenant named 'verifier'.\n \n- Create a public DID for the 'issuer'.\n \n\nThese steps are performed by DevTools - a separate web service designed to assist developers in performing various service-related tasks that are crucial for setting up and maintaining the OCM environment. Although not a part of the OCM itself, DevTools acts as an essential developer aid, providing a suite of tools and features that streamline the execution of tasks such as DID registration, tenant creation, and configuration of public DIDs.\n\nTo find out how to run the DevTools please refer to the documentation in the OCM repository."
+ "description": "This folder contains a series of preliminary requests essential for execution before proceeding with the rest of the integration tests:\n\n- Create a tenant named 'issuer'.\n- Create a tenant named 'holder'.\n- Create a tenant named 'verifier'.\n- Create a public DID for the 'issuer'."
},
{
"name": "Create Schema and Credential Definition",
@@ -531,7 +666,7 @@
"header": [],
"body": {
"mode": "raw",
- "raw": "{\n \"issuerDid\": \"{{issuer_did}}\",\n \"schemaId\": \"{{revocation_schema_id}}\",\n \"tag\": \"default\",\n \"supportsRevocation\": true\n}",
+ "raw": "{\n \"issuerDid\": \"{{issuer_did}}\",\n \"schemaId\": \"{{revocation_schema_id}}\",\n \"tag\": \"{{$randomSemver}}\",\n \"supportsRevocation\": true\n}",
"options": {
"raw": {
"language": "json"
@@ -1510,7 +1645,7 @@
"header": [],
"body": {
"mode": "raw",
- "raw": "{\n \"name\": \"{{$randomBsAdjective}}_{{$randomBsNoun}}\",\n \"connectionId\": \"{{verifier_holder_connection_id_for_verifier}}\",\n \"requestedAttributes\": {\n \"color\": {\n \"names\": [\"color\"]\n },\n \"size\": {\n \"names\": [\"size\"]\n }\n },\n \"requestedPredicates\": {}\n}",
+ "raw": "{\n \"name\": \"{{$randomBsAdjective}}_{{$randomBsNoun}}\",\n \"connectionId\": \"{{verifier_holder_connection_id_for_verifier}}\",\n \"requestedAttributes\": {\n \"tshirt_info\": {\n \"names\": [\"color\", \"size\"],\n \"restrictions\": [\n {}\n ]\n }\n },\n \"requestedPredicates\": {}\n}",
"options": {
"raw": {
"language": "json"
@@ -1670,7 +1805,8 @@
" 'Connection Manager Base URL',",
" 'Credential Manager Base URL',",
" 'Proof Manager Base URL',",
- " 'DevTools Base URL'",
+ " 'DID Manager Base URL',",
+ " 'Tenant Manager Base URL'",
"];",
"",
"for (const variable of variables) {",
@@ -1713,13 +1849,13 @@
"type": "string"
},
{
- "key": "DevTools Base URL",
- "value": "http://localhost:4100",
+ "key": "DID Manager Base URL",
+ "value": "http://localhost:4006",
"type": "string"
},
{
- "key": "DID Manager Base URL",
- "value": "http://localhost:4006",
+ "key": "Tenant Manager Base URL",
+ "value": "http://localhost:4007",
"type": "string"
},
{
@@ -1801,6 +1937,10 @@
{
"key": "revocable_credential_id",
"value": ""
+ },
+ {
+ "key": "issuer_invitationUrl",
+ "value": ""
}
]
}
\ No newline at end of file