Key Link

Add a new signing key

Adds a new signing key to the workspace. The added key will be linked to the specific Fireblocks agent user ID. The same user will receive the proof of ownership message to be signed, and upon successful proof, the key will become enabled.

post/key_link/signing_keys

Request

Headers

Idempotency-Keystring

A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.

Request body

signingDeviceKeyIdstring required

The ID, name or label of the key specified on the customer's signing device.

signedCertPemstring required

The signed certificate that includes the public key PEM of the signing key, signed by a validation key.

agentUserIdstring required

Id of user to which this key belongs

Example request

{
  "signingDeviceKeyId": "MyKey1",
  "signedCertPem": "-----BEGIN CERTIFICATE ... END CERTIFICATE-----",
  "agentUserId": "d18847b5-1df6-4c46-8f99-5cce47284529"
}

Response

Newly created signing key

keyIdstring required

External signing key id set by Fireblocks.

signingDeviceKeyIdstring required

The ID, name or label of the key specified on the customer's signing device.

publicKeyPemstring required

PEM encoded public key

algorithmstring required

Algorithm and curve used for the signature. Can be: ECDSA_SECP256K1 or EDDSA_ED25519

enabledboolean required

True if the signing key is enabled

vaultAccountIdnumber nullable required

Id of the vault account which this key is linked to

agentUserIdstring required

Id of user that represent agent servers that can sign with the key

createdAtnumber required

Creation date (timestamp) in milliseconds.

Example response

{
  "keyId": "46a92767-5f93-4a46-9eed-f012196bb4fc",
  "signingDeviceKeyId": "MyKey1",
  "publicKeyPem": "-----BEGIN PUBLIC KEY ... END PUBLIC KEY-----",
  "algorithm": "ECDSA_SECP256K1",
  "enabled": true,
  "vaultAccountId": 10,
  "agentUserId": "d18847b5-1df6-4c46-8f99-5cce47284529",
  "createdAt": 124757537
}

Changes

No recorded changes to this operation across all 1 revision of this API.