Delete key

DELETE 
/v2/config/digital-wallet/openid/key-management/keys/:keyId

Deletes a key of the organisation. The wallet deletes only its record of the key. It never deletes the key in a key store of the organisation (vault, gcp-kms, aws-kms, azure-key-vault, dpod) or at a QTSP (csc).

The wallet refuses to delete a key that is in use: the default key, a key that a credential definition, a presentation definition or a status list signs with, or a key of an issuance or a verification in flight. The read key usage operation tells where the key is in use (canDelete).

This operation needs a request body: send {"confirm": "DELETE"}. The service refuses the request when the body is missing.

When the key has a test certificate of the built-in test CA, the test CA revokes it, and the wallet signs the new CRL in the same change. When the key of the test CA cannot sign, the answer is 503 (Failed to sign the CRL of the test CA: Key management service is not available) and the key stays.

Request

Path Parameters

keyId stringrequired

Unique identifier of the key

application/json

Body

required

Confirmation of the delete operation.

confirm stringrequired

Possible values: [DELETE]

Confirmation string. Set the value to DELETE.

Responses

204

Key deleted successfully. The response body is empty.

Response Headers

400

The request body is missing, the confirmation string is not DELETE, or the key is the default key or is in use.

Response Headers

application/json

Schema

Schema

errorCode integer
errorDescription string

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

401

Unauthorized

Response Headers

application/json

Schema

Schema

errorCode integer
errorDescription string

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

404

The organisation has no key with this key ID.

Response Headers

application/json

Schema

Schema

errorCode integer
errorDescription string

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

500

Internal server error

Response Headers

application/json

Schema

Schema

errorCode integer
errorDescription string

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

503

The key has a test certificate, and the key of the test CA cannot sign the new CRL. The key stays.

Response Headers

application/json

Schema

Schema

errorCode integer
errorDescription string

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

Loading...