@google-cloud/secret-manager
    TypeScript icon, indicating that this package has built-in type declarations

    3.12.0 • Public • Published

    Google Cloud Platform logo

    Secret Manager: Node.js Client

    release level npm version

    Secrets 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 Secret Manager 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/secret-manager

    Using the client library

    // Import the Secret Manager client and instantiate it:
    const {SecretManagerServiceClient} = require('@google-cloud/secret-manager');
    const client = new SecretManagerServiceClient();
    
    /**
     * TODO(developer): Uncomment these variables before running the sample.
     */
    // parent = 'projects/my-project', // Project for which to manage secrets.
    // secretId = 'foo', // Secret ID.
    // payload = 'hello world!' // String source data.
    
    async function createAndAccessSecret() {
      // Create the secret with automation replication.
      const [secret] = await client.createSecret({
        parent: parent,
        secret: {
          name: secretId,
          replication: {
            automatic: {},
          },
        },
        secretId,
      });
    
      console.info(`Created secret ${secret.name}`);
    
      // Add a version with a payload onto the secret.
      const [version] = await client.addSecretVersion({
        parent: secret.name,
        payload: {
          data: Buffer.from(payload, 'utf8'),
        },
      });
    
      console.info(`Added secret version ${version.name}`);
    
      // Access the secret.
      const [accessResponse] = await client.accessSecretVersion({
        name: version.name,
      });
    
      const responsePayload = accessResponse.payload.data.toString('utf8');
      console.info(`Payload: ${responsePayload}`);
    }
    createAndAccessSecret();

    Samples

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

    Sample Source Code Try it
    Access Secret Version source code Open in Cloud Shell
    Add Secret Version source code Open in Cloud Shell
    Create Secret source code Open in Cloud Shell
    Delete Secret source code Open in Cloud Shell
    Destroy Secret Version source code Open in Cloud Shell
    Disable Secret Version source code Open in Cloud Shell
    Enable Secret Version source code Open in Cloud Shell
    Get Secret source code Open in Cloud Shell
    Get Secret Version source code Open in Cloud Shell
    Iam Grant Access source code Open in Cloud Shell
    Iam Revoke Access source code Open in Cloud Shell
    List Secret Versions source code Open in Cloud Shell
    List Secrets source code Open in Cloud Shell
    Quickstart source code Open in Cloud Shell
    Update Secret source code Open in Cloud Shell

    The Secret Manager Node.js Client API Reference documentation also contains samples.

    Supported Node.js Versions

    Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.

    Google's client libraries support legacy versions of Node.js runtimes on a best-efforts basis with the following warnings:

    • Legacy versions are not tested in continuous integration.
    • Some security patches and features cannot be backported.
    • Dependencies cannot be kept up-to-date.

    Client libraries targeting some end-of-life versions of Node.js are available, and can be installed through npm dist-tags. The dist-tags follow the naming convention legacy-(version). For example, npm install @google-cloud/secret-manager@legacy-8 installs client libraries for versions compatible with Node.js 8.

    Versioning

    This library follows Semantic Versioning.

    This library is considered to be stable. The code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against stable libraries are addressed with the highest priority.

    More Information: Google Cloud Platform Launch Stages

    Contributing

    Contributions welcome! See the Contributing Guide.

    Please note that this README.md, the samples/README.md, and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template. To edit one of these files, make an edit to its templates in directory.

    License

    Apache Version 2.0

    See LICENSE

    Install

    npm i @google-cloud/secret-manager

    DownloadsWeekly Downloads

    223,853

    Version

    3.12.0

    License

    Apache-2.0

    Unpacked Size

    2.6 MB

    Total Files

    28

    Last publish

    Collaborators

    • ofrobots
    • google-wombot
    • google-admin
    • soldair