Sign in

v1

latestOpenAPI 3.1.02026-07-17105740.5 KB
Universal Registrar

Deactivate a DID URL and associated resource

This endpoint deactivates a DID URL and associated resource. As input it takes an existing DID, a relative DID URL, a resource, plus optional DID registration options and secrets needed to deactivate the DID URL. The output is a state object that represents the current state of the DID URL deactivation process.

See the DID Registration specification for additional details.

post/deactivateResource

Request body

didstring required

This input field indicates the DID that is the target of the DID URL deactivate operation.

relativeDidUrlstring required

This input field indicates a relative DID URL that is the target of the DID URL deactivate operation.

Example request

{
  "options": {
    "clientSecretMode": true,
    "network": "testnet"
  },
  "secret": {
    "seed": "72WGp7NgFR1Oqdi8zlt7jQQ434XR0cNQ",
    "verificationMethod": [
      {
        "id": "did:indy:sovrin:WRfXPg8dantKVubE3HX8pw#key-1",
        "type": "JsonWebKey2020",
        "privateKeyJwk": {
          "kty": "OKP",
          "crv": "Ed25519",
          "d": "NzJXR3A3TmdGUjFPcWRpOHpsdDdqUVE0MzRYUjBjTlE",
          "x": "jpIKKU2b77lNXKTNW2NGvw1GUMjU6v_l_tLJAH5uYz0"
        }
      }
    ]
  },
  "did": "did:indy:sovrin:WRfXPg8dantKVubE3HX8pw",
  "relativeDidUrl": "/resources/123"
}

Response

The request was successful, and the DID URL may or may not be fully deactivated yet, as indicated by the "didState.state" and "jobId" output fields. Additional state information plus metadata are available in the response body.

didRegistrationMetadataobject
contentMetadataobject

Example response

{
  "didUrlState": {
    "secret": {
      "verificationMethod": [
        {
          "id": "did:indy:sovrin:WRfXPg8dantKVubE3HX8pw#key-1",
          "type": "JsonWebKey2020",
          "privateKeyJwk": {
            "kty": "OKP",
            "crv": "Ed25519",
            "d": "NzJXR3A3TmdGUjFPcWRpOHpsdDdqUVE0MzRYUjBjTlE",
            "x": "jpIKKU2b77lNXKTNW2NGvw1GUMjU6v_l_tLJAH5uYz0"
          }
        }
      ]
    }
  }
}