Documentation/canton-network-docs/Admin APIgRPC APIPackagescom.digitalasset.canton.crypto.admin.v30ServicesVaultServiceView on canton-network-docs ↗
canton-network-docs/Admin APIgRPC APIPackagescom.digitalasset.canton.crypto.admin.v30ServicesVaultService

RegisterKmsEncryptionKey

Shared Administration›Protobuf›com.digitalasset.canton.crypto.admin.v30›RegisterKmsEncryptionKey

com.digitalasset.canton.crypto.admin.v30

​
RegisterKmsEncryptionKey

gRPCSince 3.4.0
RPC/com.digitalasset.canton.crypto.admin.v30.VaultService/RegisterKmsEncryptionKey

​
Protocol Details

​
Inputs

​
RegisterKmsEncryptionKeyRequest

kms_key_idstring
namestring

​
Outputs

​
RegisterKmsEncryptionKeyResponse

public_keyEncryptionPublicKey

​
Lifecycle Changes

3.4.0introduced

com.digitalasset.canton.crypto.admin.v30.RegisterKmsEncryptionKeyRequest

kms_key_idstring
namestring

com.digitalasset.canton.crypto.admin.v30.RegisterKmsEncryptionKeyResponse

public_keyEncryptionPublicKey
grpcurl
grpcurl
# Add -plaintext if the server is not using TLS.
grpcurl \
  -d @ \
  <HOST:PORT> \
  com.digitalasset.canton.crypto.admin.v30.VaultService/RegisterKmsEncryptionKey <<'EOF'
{
  "kmsKeyId": "string",
  "name": "string"
}
EOF
OKapplication/json
OK
{
  "publicKey": "string"
}