Updating a DID

Function

This API is used to update the services published in a DID document.

URI

PUT /v1/identity/did

Request Parameters

**Table 1** Request body parameters
Parameter	Mandatory	Type	Description
orgID	Yes	String	Organization ID.
channelID	Yes	String	Channel ID.
cryptoMethod	Yes	String	Encryption method, which is fixed at SW.
cert	Yes	String	User certificate. Add an explicit line break (\n) at the end of each line.
sk	Yes	String	User private key. Add an explicit line break (\n) at the end of each line.
timestamp	Yes	String	Timestamp.
did	Yes	String	Decentralized identifier.
service	No	Array of DIDService objects	Service list.

**Table 2** DIDService
Parameter	Mandatory	Type	Description
type	Yes	String	Type.
serviceEndpoint	Yes	String	Endpoint.
credentialApplySchema	No	CredentialApplySchema object	Schema used for applying for a VC.

**Table 3** CredentialApplySchema
Parameter	Mandatory	Type	Description
type	No	String	Type.
name	No	String	Name.
description	No	String	Description.
attributes	No	Array of Attribute objects	Attributes.

**Table 4** Attribute
Parameter	Mandatory	Type	Description
name	No	String	Name.
type	No	String	Type.
description	No	String	Description.

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
context	String	context
id	String	Decentralized identifier.
publicKey	Array of DocPublicKey objects	Public keys.
authentication	Array of strings	Identifier of the DID master public key.
recovery	String	Identifier of the DID backup public key, which can be used to modify the master key.
service	Array of Service objects	Service list.
proof	Proof object	Proof structure, which can be left empty.
created	String	Creation time.
updated	String	Update time.
status	String	Status.

**Table 6** DocPublicKey
Parameter	Type	Description
id	String	Public key identifier.
type	String	Public key type.
controller	String	Public key controller identifier.
publicKeyPem	String	Public key certificate.

**Table 7** Service
Parameter	Type	Description
id	String	Service identifier.
type	String	Service type.
serviceEndpoint	String	Service endpoint.
credentialApplySchema	CredentialApplySchema object	Schema used for applying for a VC.

**Table 8** CredentialApplySchema
Parameter	Type	Description
type	String	Type.
name	String	Name.
description	String	Description.
attributes	Array of Attribute objects	Attributes.

**Table 9** Attribute
Parameter	Type	Description
name	String	Name.
type	String	Type.
description	String	Description.

**Table 10** Proof
Parameter	Type	Description
creator	String	Creator identifier.
type	String	Signature type.
created	String	Signature creation time.
signatureValue	String	Signature.

Status code: 500

**Table 11** Response body parameters
Parameter	Type	Description
errorCode	String	Error code. Minimum: 8 Maximum: 36
errorMsg	String	Error description. Minimum: 2 Maximum: 512

Example Requests

{
  "orgID" : "4f1439758ebb41f7411b5f684b67713c08b89198",
  "channelID" : "mychannel",
  "cryptoMethod" : "SW",
  "cert" : "-----BEGIN CERTIFICATE-----\n...\n...\n-----END CERTIFICATE-----",
  "sk" : "------BEGIN PRIVATE KEY-----\n...\n...\n-----END PRIVATE KEY-----",
  "timestamp" : "2020-10-27T17:28:16+08:00",
  "did" : "did:example:ebfeb1f712ebc6f1c276e12ec21",
  "service" : [ {
    "type" : "VerifiableCredentialService",
    "serviceEndpoint" : "https://example.com/vc/",
    "credentialApplySchema" : {
      "type" : "file",
      "name" : "Test Enterprise Certification",
      "description" : "this is test apply info",
      "attributes" : [ {
        "name" : "bob",
        "type" : "string",
        "description" : "Attribute's description"
      } ]
    }
  } ]
}

Example Responses

Status code: 500

Error response.

{
  "errorCode" : "BCS.5002033",
  "errorMsg" : "Service Type and ServiceEndpoint Can not Null"
}

Status Codes

Status Code	Description
200	DID document structure.
500	Error response.

Error Codes

See Error Codes.

Parent topic: Decentralized Identity (DID) Management

Previous topic: Registering a DID

Next topic: Querying a DID

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot