plugin.schema.json

{
  "IWellKnownDidConfigurationPlugin": {
    "components": {
      "schemas": {
        "IWellKnownDidConfigurationPluginArgs": {
          "type": "object",
          "properties": {
            "dids": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "List of DIDs to be included in the DID configuration file. Each DID needs to be managed by this agent."
            },
            "domain": {
              "type": "string",
              "description": "The domain name linked to the DIDs."
            },
            "save": {
              "type": "boolean",
              "description": "Store the VCs used in the DID configuration"
            }
          },
          "required": [
            "dids",
            "domain"
          ],
          "description": "The arguments for the .well-known DID configuration plugin."
        },
        "IDidConfigurationSchema": {
          "type": "object",
          "properties": {
            "@context": {
              "type": "string",
              "description": "https://identity.foundation/.well-known/contexts/did-configuration-v0.0.jsonld"
            },
            "linked_dids": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/VerifiableCredentialOrJwt"
              },
              "description": "The list of VCs linking"
            },
            "entries": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/VerifiableCredentialOrJwt"
              },
              "description": "Legacy support."
            }
          },
          "required": [
            "@context",
            "linked_dids"
          ],
          "description": "The `DID configuration`"
        },
        "VerifiableCredentialOrJwt": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/VerifiableCredential"
            },
            {
              "type": "string"
            }
          ]
        },
        "VerifiableCredential": {
          "type": "object",
          "properties": {
            "@context": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "id": {
              "type": "string"
            },
            "type": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "issuer": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                }
              },
              "required": [
                "id"
              ]
            },
            "issuanceDate": {
              "type": "string"
            },
            "expirationDate": {
              "type": "string"
            },
            "credentialSubject": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                }
              }
            },
            "credentialStatus": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "type": {
                  "type": "string"
                }
              },
              "required": [
                "id",
                "type"
              ]
            },
            "proof": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string"
                }
              }
            }
          },
          "required": [
            "@context",
            "type",
            "issuer",
            "issuanceDate",
            "credentialSubject",
            "proof"
          ],
          "description": "Verifiable Credential  {@link  https://github.com/decentralized-identifier/did-jwt-vc }"
        },
        "IWellKnownDidConfigurationVerificationArgs": {
          "type": "object",
          "properties": {
            "domain": {
              "type": "string",
              "description": "The web domain name which will be used to retrieve the .well-know DID configuration."
            }
          },
          "required": [
            "domain"
          ],
          "description": "The arguments to verify the .well-known DID configuration from a web domain."
        },
        "IWKDidConfigVerification": {
          "type": "object",
          "properties": {
            "domain": {
              "type": "string",
              "description": "The domain used in the verification"
            },
            "dids": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "The DIDs in the DID configuration"
            },
            "errors": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/IWKDidConfigVerificationError"
              },
              "description": "Possible failures during the verification of each VC in the DID configuration."
            },
            "didConfiguration": {
              "$ref": "#/components/schemas/IDidConfigurationSchema",
              "description": "The DID configuration with JWTs exapanded."
            },
            "valid": {
              "type": "boolean",
              "description": "Validity of the DID configuration"
            },
            "rawDidConfiguration": {
              "type": "string",
              "description": "The raw DID configuration."
            }
          },
          "required": [
            "domain",
            "dids",
            "errors",
            "didConfiguration",
            "valid",
            "rawDidConfiguration"
          ],
          "description": "Well Known DID Configuration verification response"
        },
        "IWKDidConfigVerificationError": {
          "type": "object",
          "properties": {
            "vc": {
              "type": "string",
              "description": "The VC that failed in the verification."
            },
            "errors": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "Reason for the verification error. Detailed error messages."
            }
          },
          "required": [
            "vc",
            "errors"
          ],
          "description": "The DID configuration can contain DIDs which methods are not resolved yet or VCs  not following the well-known DID configuration specification. In those cases this object is returned with details about the verification process."
        }
      },
      "methods": {
        "generateDidConfiguration": {
          "description": "Generates a DID configuration for a domain including a list of DID \"owned\" by the DID agent.",
          "arguments": {
            "$ref": "#/components/schemas/IWellKnownDidConfigurationPluginArgs"
          },
          "returnType": {
            "$ref": "#/components/schemas/IDidConfigurationSchema"
          }
        },
        "verifyWellKnownDidConfiguration": {
          "description": "",
          "arguments": {
            "$ref": "#/components/schemas/IWellKnownDidConfigurationVerificationArgs"
          },
          "returnType": {
            "$ref": "#/components/schemas/IWKDidConfigVerification"
          }
        }
      }
    }
  }
}