curl --request DELETE \
--url "https://directory.example.com/dids/did%3Aopenpayload%3A1111111111111111111111/document/key-agreements/did%3Aopenpayload%3A1111111111111111111111%23agreement" \
--header "Content-Type: application/json" \
--data '{
"did": "did:openpayload:1111111111111111111111",
"action": "RemoveKeyAgreement",
"id": "did:openpayload:1111111111111111111111#agreement",
"nonce": "<nonce>",
"valid_until": "<future-epoch-milliseconds>",
"signer_key_id": "root",
"canonical_payload": "<payload>",
"signature": "<signature>"
}'
{
"status": "accepted",
"did": "did:openpayload:1111111111111111111111",
"action": "RemoveKeyAgreement",
"tx_hash": "<transaction-hash>",
"message": "DID document modification submitted"
}
DID documents
Remove key agreement
Remove key agreement in a public OpenPayload DID document.
curl --request DELETE \
--url "https://directory.example.com/dids/did%3Aopenpayload%3A1111111111111111111111/document/key-agreements/did%3Aopenpayload%3A1111111111111111111111%23agreement" \
--header "Content-Type: application/json" \
--data '{
"did": "did:openpayload:1111111111111111111111",
"action": "RemoveKeyAgreement",
"id": "did:openpayload:1111111111111111111111#agreement",
"nonce": "<nonce>",
"valid_until": "<future-epoch-milliseconds>",
"signer_key_id": "root",
"canonical_payload": "<payload>",
"signature": "<signature>"
}'
{
"status": "accepted",
"did": "did:openpayload:1111111111111111111111",
"action": "RemoveKeyAgreement",
"tx_hash": "<transaction-hash>",
"message": "DID document modification submitted"
}
Remove key agreement in a public OpenPayload DID document.
Removing a key-agreement method tells compatible clients not to select that public key for new encryption. It cannot recall messages already encrypted to the old key.
Read Authorize a Directory update before signing.
Path parameters
string
required
The DID to update.
string
required
The key-agreement ID.
Request body
string
required
The DID to update. It must match the path.
string
required
The operation name. Use
RemoveKeyAgreement.string
required
The public id value for this operation.
string
required
The request nonce.
string
required
The authorization expiration time.
string
The public signing-key identifier. Defaults to
root.string
required
The payload supplied by an OpenPayload-compatible signer.
string
required
The authorization signature.
curl --request DELETE \
--url "https://directory.example.com/dids/did%3Aopenpayload%3A1111111111111111111111/document/key-agreements/did%3Aopenpayload%3A1111111111111111111111%23agreement" \
--header "Content-Type: application/json" \
--data '{
"did": "did:openpayload:1111111111111111111111",
"action": "RemoveKeyAgreement",
"id": "did:openpayload:1111111111111111111111#agreement",
"nonce": "<nonce>",
"valid_until": "<future-epoch-milliseconds>",
"signer_key_id": "root",
"canonical_payload": "<payload>",
"signature": "<signature>"
}'
Response
string
required
The submission status.
string
required
The affected DID.
string
required
The document operation.
string
required
The transaction hash.
string
required
A human-readable submission result.
{
"status": "accepted",
"did": "did:openpayload:1111111111111111111111",
"action": "RemoveKeyAgreement",
"tx_hash": "<transaction-hash>",
"message": "DID document modification submitted"
}
202 Accepted means the Directory accepted the request for processing. It does not confirm final settlement.Straight to the point
- Action:
RemoveKeyAgreement - Signed item: key-agreement
id - Rotate clients before removing their last usable key