Key Link

Get list of signing keys

Returns the list of signing keys in the workspace

get/key_link/signing_keys

Request

Query parameters

pageCursorstring

Cursor to the next page

pageSizenumber

Amount of results to return in the next page

sortBy'createdAt'

Field(s) to use for sorting

order'ASC' | 'DESC'

Is the order ascending or descending

vaultAccountIdnumber

Return keys assigned to a specific vault

agentUserIdstring

Return keys associated with a specific agent user

algorithm'ECDSA_SECP256K1' | 'EDDSA_ED25519'

Return only keys with a specific algorithm

enabledboolean

Return keys that have been proof of ownership

availableboolean

Return keys that are proof of ownership but not assigned. Available filter can be used only when vaultAccountId and enabled filters are not set

isAssignedboolean nullable

Return keys that are assigned to a vault account

keyPrefixstring

A case-insensitive prefix filter that matches records where either keyId or signingDeviceKeyID starts with the specified value.

Response

List of signing keys and a data that allows requesting the next page if applicable

nextstring

The ID of the next page

Example response

{
  "data": [
    {
      "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.