curl --request DELETE \
--url "https://directory.example.com/dids/did%3Aopenpayload%3A1111111111111111111111/document/authentication/did%3Aopenpayload%3A1111111111111111111111%23signing" \
--header "Content-Type: application/json" \
--data '{
"did": "did:openpayload:1111111111111111111111",
"action": "RemoveAuthentication",
"id": "did:openpayload:1111111111111111111111#signing",
"nonce": "<nonce>",
"valid_until": "<future-epoch-milliseconds>",
"signer_key_id": "root",
"canonical_payload": "<payload>",
"signature": "<signature>"
}'
{
"status": "accepted",
"did": "did:openpayload:1111111111111111111111",
"action": "RemoveAuthentication",
"tx_hash": "<transaction-hash>",
"message": "DID document modification submitted"
}
DID documents
Remove authentication method
Remove authentication method in a public OpenPayload DID document.
curl --request DELETE \
--url "https://directory.example.com/dids/did%3Aopenpayload%3A1111111111111111111111/document/authentication/did%3Aopenpayload%3A1111111111111111111111%23signing" \
--header "Content-Type: application/json" \
--data '{
"did": "did:openpayload:1111111111111111111111",
"action": "RemoveAuthentication",
"id": "did:openpayload:1111111111111111111111#signing",
"nonce": "<nonce>",
"valid_until": "<future-epoch-milliseconds>",
"signer_key_id": "root",
"canonical_payload": "<payload>",
"signature": "<signature>"
}'
{
"status": "accepted",
"did": "did:openpayload:1111111111111111111111",
"action": "RemoveAuthentication",
"tx_hash": "<transaction-hash>",
"message": "DID document modification submitted"
}
Remove authentication method in a public OpenPayload DID document.
This removes one key’s permission to authenticate as the DID. It does not automatically remove the underlying verification method.
Read Authorize a Directory update before signing.
Path parameters
string
required
The DID to update.
string
required
The authentication method ID.
Request body
string
required
The DID to update. It must match the path.
string
required
The operation name. Use
RemoveAuthentication.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/authentication/did%3Aopenpayload%3A1111111111111111111111%23signing" \
--header "Content-Type: application/json" \
--data '{
"did": "did:openpayload:1111111111111111111111",
"action": "RemoveAuthentication",
"id": "did:openpayload:1111111111111111111111#signing",
"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": "RemoveAuthentication",
"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:
RemoveAuthentication - Signed item: authentication method
id - Underlying public key may remain in
verificationMethod