diff --git a/docs/docusaurus/credentials/connectionless/issue.md b/docs/docusaurus/credentials/connectionless/issue.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/docusaurus/credentials/connectionless/present-proof.md b/docs/docusaurus/credentials/connectionless/present-proof.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/docusaurus/credentials/connectionless/present.md b/docs/docusaurus/credentials/connectionless/present.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/docusaurus/credentials/anoncreds-setup.png b/docs/docusaurus/credentials/didcomm/anoncreds-setup.png similarity index 100% rename from docs/docusaurus/credentials/anoncreds-setup.png rename to docs/docusaurus/credentials/didcomm/anoncreds-setup.png diff --git a/docs/docusaurus/credentials/anoncreds-setup.puml b/docs/docusaurus/credentials/didcomm/anoncreds-setup.puml similarity index 100% rename from docs/docusaurus/credentials/anoncreds-setup.puml rename to docs/docusaurus/credentials/didcomm/anoncreds-setup.puml diff --git a/docs/docusaurus/credentials/anoncreds-issue-flow.png b/docs/docusaurus/credentials/didcomm/issue-flow.anoncreds.png similarity index 100% rename from docs/docusaurus/credentials/anoncreds-issue-flow.png rename to docs/docusaurus/credentials/didcomm/issue-flow.anoncreds.png diff --git a/docs/docusaurus/credentials/anoncreds-issue-flow.puml b/docs/docusaurus/credentials/didcomm/issue-flow.anoncreds.puml similarity index 100% rename from docs/docusaurus/credentials/anoncreds-issue-flow.puml rename to docs/docusaurus/credentials/didcomm/issue-flow.anoncreds.puml diff --git a/docs/docusaurus/credentials/issue-flow.png b/docs/docusaurus/credentials/didcomm/issue-flow.jwt.png similarity index 100% rename from docs/docusaurus/credentials/issue-flow.png rename to docs/docusaurus/credentials/didcomm/issue-flow.jwt.png diff --git a/docs/docusaurus/credentials/issue-flow.puml b/docs/docusaurus/credentials/didcomm/issue-flow.jwt.puml similarity index 100% rename from docs/docusaurus/credentials/issue-flow.puml rename to docs/docusaurus/credentials/didcomm/issue-flow.jwt.puml diff --git a/docs/docusaurus/credentials/issue.md b/docs/docusaurus/credentials/didcomm/issue.md similarity index 95% rename from docs/docusaurus/credentials/issue.md rename to docs/docusaurus/credentials/didcomm/issue.md index ff9beeae99..ff03f581b2 100644 --- a/docs/docusaurus/credentials/issue.md +++ b/docs/docusaurus/credentials/didcomm/issue.md @@ -23,24 +23,24 @@ Before using the Issuing Credentials protocol, the following conditions must be 1. Issuer and Holder Cloud Agents up and running -2. A connection must be established between the Issuer and Holder Cloud Agents (see [Connections](../connections/connection.md)) -3. The Issuer must have a published PRISM DID, and the [DID document](/docs/concepts/glossary#did-document) must have at least one `assertionMethod` key for issuing credentials (see [Create DID](../dids/create.md) and [Publish DID](../dids/publish.md)) +2. A connection must be established between the Issuer and Holder Cloud Agents (see [Connections](../../connections/connection.md)) +3. The Issuer must have a published PRISM DID, and the [DID document](/docs/concepts/glossary#did-document) must have at least one `assertionMethod` key for issuing credentials (see [Create DID](../../dids/create.md) and [Publish DID](../../dids/publish.md)) 4. The Holder must have a PRISM DID, and the DID document must have at least one `authentication` key for presenting the proof. 1. Issuer and Holder Cloud Agents up and running -2. A connection must be established between the Issuer and Holder Cloud Agents (see [Connections](../connections/connection.md)) -3. The Issuer must have created an AnonCreds Credential Definition as described [here](../credentialdefinition/create.md). +2. A connection must be established between the Issuer and Holder Cloud Agents (see [Connections](../../connections/connection.md)) +3. The Issuer must have created an AnonCreds Credential Definition as described [here](../../credentialdefinition/create.md). - 📌 **Note:** Currently we only support `Ed25519` curve 1. Issuer and Holder Cloud Agents up and running -2. A connection must be established between the Issuer and Holder Cloud Agents (see [Connections](../connections/connection.md)) -3. The Issuer must have a published PRISM DID, and the [DID document](/docs/concepts/glossary#did-document) must have at least one `assertionMethod` key for issuing credentials and the curve must be `Ed25519` (see [Create DID](../dids/create.md) and [Publish DID](../dids/publish.md)) +2. A connection must be established between the Issuer and Holder Cloud Agents (see [Connections](../../connections/connection.md)) +3. The Issuer must have a published PRISM DID, and the [DID document](/docs/concepts/glossary#did-document) must have at least one `assertionMethod` key for issuing credentials and the curve must be `Ed25519` (see [Create DID](../../dids/create.md) and [Publish DID](../../dids/publish.md)) 4. The Holder must have a PRISM DID, and the DID document must have at least one `authentication` key for presenting the proof and the curve must be `Ed25519`. @@ -95,7 +95,7 @@ To do this, make a `POST` request to the [`/issue-credentials/credential-offers` 4. `schemaId`: An optional field that, if specified, contains a valid URL to an existing VC schema. The Cloud Agent must be able to dereference the specified URL (i.e. fetch the VC schema content from it), in order to validate the provided claims against it. When not specified, the claims fields is not validated and can be any valid JSON object. - Please refer to the [Create VC schema](../schemas/create.md) doc for details on how to create a VC schema. + Please refer to the [Create VC schema](../../schemas/create.md) doc for details on how to create a VC schema. 5. `credentialFormat`: The format of the credential that will be issued - `JWT` in this case. When not specified, the default value is `JWT`. @@ -133,9 +133,9 @@ curl -X 'POST' \ 1. `claims`: The data stored in a verifiable credential. AnonCreds claims get expressed in a flat, "string -> string", key-value pair format. The claims contain the data that the issuer attests to, such as name, address, date of birth, and so on. 2. `connectionId`: The unique ID of the connection between the holder and the issuer to offer this credential over. -3. `credentialDefinitionId`: The unique ID of the [credential definition](../credentialdefinition/credential-definition.md) that has been created by the issuer as a prerequisite. Please refer to the [Create AnonCreds Credential Definition](../credentialdefinition/credential-definition.md) doc for details on how to create a credential definition. +3. `credentialDefinitionId`: The unique ID of the [credential definition](../../credentialdefinition/credential-definition.md) that has been created by the issuer as a prerequisite. Please refer to the [Create AnonCreds Credential Definition](../../credentialdefinition/credential-definition.md) doc for details on how to create a credential definition. :::note -📌 Note: If the credential definition was created via HTTP URL endpoint, then this credential definition will be referenced to that credential via HTTP URL, and if this credential definition was created via DID URL endpoint, then it will be referenced via DID URL, How to create credential definition for HTTP URL or DID URL is explained in [credential definition creation guide](../credentialdefinition/create.md) +📌 Note: If the credential definition was created via HTTP URL endpoint, then this credential definition will be referenced to that credential via HTTP URL, and if this credential definition was created via DID URL endpoint, then it will be referenced via DID URL, How to create credential definition for HTTP URL or DID URL is explained in [credential definition creation guide](../../credentialdefinition/create.md) ::: 4. `credentialFormat`: The format of the credential that will be issued - `AnonCreds` in this case. 5. `issuingDID`: The DID referring to the issuer to issue this credential from @@ -178,7 +178,7 @@ curl -X 'POST' \ 4. `schemaId`: An optional field that, if specified, contains a valid URL to an existing VC schema. The Cloud Agent must be able to dereference the specified URL (i.e. fetch the VC schema content from it), in order to validate the provided claims against it. When not specified, the claims fields is not validated and can be any valid JSON object. - Please refer to the [Create VC schema](../schemas/create.md) doc for details on how to create a VC schema. + Please refer to the [Create VC schema](../../schemas/create.md) doc for details on how to create a VC schema. 5. `credentialFormat`: The format of the credential that will be issued - `SDJWT` in this case. @@ -435,12 +435,12 @@ The following diagram shows the end-to-end flow for an issuer to issue a VC to a -![](issue-flow.png) +![](issue-flow.jwt.png) -![](anoncreds-issue-flow.png) +![](issue-flow.anoncreds.png) - \ No newline at end of file + diff --git a/docs/docusaurus/credentials/anoncreds-present-proof-flow.png b/docs/docusaurus/credentials/didcomm/present-proof-flow.anoncreds.png similarity index 100% rename from docs/docusaurus/credentials/anoncreds-present-proof-flow.png rename to docs/docusaurus/credentials/didcomm/present-proof-flow.anoncreds.png diff --git a/docs/docusaurus/credentials/anoncreds-present-proof-flow.puml b/docs/docusaurus/credentials/didcomm/present-proof-flow.anoncreds.puml similarity index 100% rename from docs/docusaurus/credentials/anoncreds-present-proof-flow.puml rename to docs/docusaurus/credentials/didcomm/present-proof-flow.anoncreds.puml diff --git a/docs/docusaurus/credentials/present-proof-flow.png b/docs/docusaurus/credentials/didcomm/present-proof-flow.jwt.png similarity index 100% rename from docs/docusaurus/credentials/present-proof-flow.png rename to docs/docusaurus/credentials/didcomm/present-proof-flow.jwt.png diff --git a/docs/docusaurus/credentials/present-proof-flow.puml b/docs/docusaurus/credentials/didcomm/present-proof-flow.jwt.puml similarity index 100% rename from docs/docusaurus/credentials/present-proof-flow.puml rename to docs/docusaurus/credentials/didcomm/present-proof-flow.jwt.puml diff --git a/docs/docusaurus/credentials/present-proof.md b/docs/docusaurus/credentials/didcomm/present-proof.md similarity index 98% rename from docs/docusaurus/credentials/present-proof.md rename to docs/docusaurus/credentials/didcomm/present-proof.md index 280fea81c5..406f9d1cd9 100644 --- a/docs/docusaurus/credentials/present-proof.md +++ b/docs/docusaurus/credentials/didcomm/present-proof.md @@ -1,7 +1,7 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# Present proof +# Present proof (DIDComm) The [Present Proof Protocol](/docs/concepts/glossary#present-proof-protocol) allows: - a [Verifier](/docs/concepts/glossary#verifier) to request a verifiable credential presentation from a Holder/Prover @@ -21,7 +21,7 @@ The present proof protocol has two roles: Before using the Proof Presentation protocol, the following conditions must be present: 1. Holder/Prover and Verifier Cloud Agents must be up and running -2. A connection must be established between the Holder/Prover and Verifier Cloud Agents (see [Connections](../connections/connection.md)) +2. A connection must be established between the Holder/Prover and Verifier Cloud Agents (see [Connections](../../connections/connection.md)) 3. The Holder/Prover should hold a [verifiable credential (VC)](/docs/concepts/glossary#verifiable-credential) received from an [Issuer](/docs/concepts/glossary#issuer) see [Issue](./issue.md). ## Overview @@ -323,20 +323,15 @@ stateDiagram-v2 The following diagram shows the end-to-end flow for a verifier to request and verify a proof presentation from a Holder/prover. -### JWT Present Proof Flow Diagram -![](present-proof-flow.png) -### Anoncreds Present Proof Flow Diagram -![](anoncreds-present-proof-flow.png) - -![](present-proof-flow.png) +![](present-proof-flow.jwt.png) -![](anoncreds-present-proof-flow.png) +![](present-proof-flow.anoncreds.png) - \ No newline at end of file + diff --git a/docs/docusaurus/credentials/oid4vci.md b/docs/docusaurus/credentials/oid4cv/issue.md similarity index 99% rename from docs/docusaurus/credentials/oid4vci.md rename to docs/docusaurus/credentials/oid4cv/issue.md index a84b7c7dfe..8bcf839b1c 100644 --- a/docs/docusaurus/credentials/oid4vci.md +++ b/docs/docusaurus/credentials/oid4cv/issue.md @@ -1,4 +1,4 @@ -# Issue credentials (OID4VCI) +# Issue credentials (OID4VC) [OID4VCI](/docs/concepts/glossary#oid4vci) (OpenID for Verifiable Credential Issuance) is a protocol that extends OAuth2 to issue credentials. It involves a Credential Issuer server and an Authorization server working together, diff --git a/docs/docusaurus/sidebars.js b/docs/docusaurus/sidebars.js index b746ea93f5..003b90fafb 100644 --- a/docs/docusaurus/sidebars.js +++ b/docs/docusaurus/sidebars.js @@ -19,9 +19,9 @@ const sidebars = { description: 'Credentials tutorials' }, items: [ - 'credentials/issue', - 'credentials/oid4vci', - 'credentials/present-proof', + 'credentials/didcomm/issue', + 'credentials/oid4ci/issue', + 'credentials/didcomm/present-proof', 'credentials/revocation' ] },