Delete key store
DELETE/v2/config/digital-wallet/openid/key-management/key-stores/:keyStoreId
Deletes a key store that the organisation added. The key store must have no keys of the organisation: delete them first with the delete key operation. The wallet deletes only its record of the key store. It never deletes a key in the key store of the provider (a vault, a cloud KMS, a DPoD partition or a QTSP).
This operation needs a request body: send {"confirm": "DELETE"}. A local key store cannot be deleted. A sandbox organisation cannot delete a key store.
Request
Path Parameters
Possible values: <= 64 characters
Unique identifier of the key store. local-openbao, local-database or local-hsm for a key store of the installation, else the identifier that the create key store operation returned.
- application/json
Body
required
Confirmation of the delete operation.
Possible values: [DELETE]
Confirmation string. Set the value to DELETE.
Responses
- 204
- 400
- 401
- 404
- 409
- 500
Key store deleted successfully. The response body is empty.
Response Headers
The confirmation string is missing or is not DELETE, the key store is a local key store, or the organisation is a sandbox organisation.
Response Headers
- application/json
- Schema
- Example (from schema)
Schema
{
"errorCode": 400,
"errorDescription": "Bad input parameter"
}
Unauthorized
Response Headers
- application/json
- Schema
- Example (from schema)
Schema
{
"errorCode": 400,
"errorDescription": "Bad input parameter"
}
The organisation has no key store with this ID.
Response Headers
- application/json
- Schema
- Example (from schema)
Schema
{
"errorCode": 400,
"errorDescription": "Bad input parameter"
}
The key store has keys of the organisation.
Response Headers
- application/json
- Schema
- Example (from schema)
Schema
{
"errorCode": 400,
"errorDescription": "Bad input parameter"
}
Internal server error
Response Headers
- application/json
- Schema
- Example (from schema)
Schema
{
"errorCode": 400,
"errorDescription": "Bad input parameter"
}