Google Cloud Key Management Service: Node.js Client

release level npm version

Google Cloud Key Management Service (KMS) API client for Node.js

A comprehensive list of changes in each version may be found in the CHANGELOG.

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.

Table of contents:

Quickstart

Before you begin

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Enable the Google Cloud Key Management Service API.
  4. Set up authentication with a service account so you can access the API from your local workstation.

Installing the client library

npm install @google-cloud/kms

Using the client library

//
// TODO(developer): Uncomment these variables before running the sample.
//
// const projectId = 'my-project';
// const locationId = 'us-east1';

// Imports the Cloud KMS library
const {KeyManagementServiceClient} = require('@google-cloud/kms');

// Instantiates a client
const client = new KeyManagementServiceClient();

// Build the location name
const locationName = client.locationPath(projectId, locationId);

async function listKeyRings() {
  const [keyRings] = await client.listKeyRings({
    parent: locationName,
  });

  for (const keyRing of keyRings) {
    console.log(keyRing.name);
  }

  return keyRings;
}

return listKeyRings();

Samples

Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.

Sample Source Code Try it
Autokey.create_key_handle source code Open in Cloud Shell
Autokey.get_key_handle source code Open in Cloud Shell
Autokey.list_key_handles source code Open in Cloud Shell
Autokey_admin.get_autokey_config source code Open in Cloud Shell
Autokey_admin.show_effective_autokey_config source code Open in Cloud Shell
Autokey_admin.update_autokey_config source code Open in Cloud Shell
Ekm_service.create_ekm_connection source code Open in Cloud Shell
Ekm_service.get_ekm_config source code Open in Cloud Shell
Ekm_service.get_ekm_connection source code Open in Cloud Shell
Ekm_service.list_ekm_connections source code Open in Cloud Shell
Ekm_service.update_ekm_config source code Open in Cloud Shell
Ekm_service.update_ekm_connection source code Open in Cloud Shell
Ekm_service.verify_connectivity source code Open in Cloud Shell
Key_management_service.asymmetric_decrypt source code Open in Cloud Shell
Key_management_service.asymmetric_sign source code Open in Cloud Shell
Key_management_service.create_crypto_key source code Open in Cloud Shell
Key_management_service.create_crypto_key_version source code Open in Cloud Shell
Key_management_service.create_import_job source code Open in Cloud Shell
Key_management_service.create_key_ring source code Open in Cloud Shell
Key_management_service.decrypt source code Open in Cloud Shell
Key_management_service.destroy_crypto_key_version source code Open in Cloud Shell
Key_management_service.encrypt source code Open in Cloud Shell
Key_management_service.generate_random_bytes source code Open in Cloud Shell
Key_management_service.get_crypto_key source code