@google-cloud/secret-manager
v3.12.0
Secrets client for Node.js
0/weekUpdated 3 months agoApache-2.0Unpacked: 2.6 MB
Published by Google LLC
npm install @google-cloud/secret-manager[//]: # "partials.introduction"
[//]: # "This README.md file is auto-generated, all changes to this file will be lost."
[//]: # "To regenerate it, use python -m synthtool."
Secret Manager: Node.js Client
Secrets client for Node.js
A comprehensive list of changes in each version may be found in
the CHANGELOG.
* [Secret Manager Node.js Client API Reference][client-docs]
* [Secret Manager Documentation][product-docs]
* github.com/googleapis/google-cloud-node/packages/google-cloud-secretmanager
Read more about the client libraries for Cloud APIs, including the older
Google APIs Client Libraries, in [Client Libraries Explained][explained].
[explained]: https://cloud.google.com/apis/docs/client-libraries-explained
Table of contents:
* Quickstart
* Before you begin
* Installing the client library
* Using the client library
* Samples
* Versioning
* Contributing
* License
Quickstart
$3
1. [Select or create a Cloud Platform project][projects].
1. [Enable billing for your project][billing].
1. [Enable the Secret Manager API][enable_api].
1. [Set up authentication][auth] so you can access the
API from your local workstation.
$3
``bash`
npm install @google-cloud/secret-manager
$3
`javascriptprojects/
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the project associated with the
Secrets google.cloud.secretmanager.v1.Secret, in the format .
*/
// const parent = 'abc123'
/**
* Optional. The maximum number of results to be returned in a single page. If
* set to 0, the server decides the number of results to return. If the
* number is greater than 25000, it is capped at 25000.
*/
// const pageSize = 1234
/**
* Optional. Pagination token, returned earlier via
* ListSecretsResponse.next_page_token google.cloud.secretmanager.v1.ListSecretsResponse.next_page_token.
*/
// const pageToken = 'abc123'
/**
* Optional. Filter string, adhering to the rules in
* List-operation
* filtering (https://cloud.google.com/secret-manager/docs/filtering). List
* only secrets matching the filter. If filter is empty, all secrets are
* listed.
*/
// const filter = 'abc123'
// Imports the Secretmanager library
const {SecretManagerServiceClient} =
require('@google-cloud/secret-manager').v1;
// Instantiates a client
const secretmanagerClient = new SecretManagerServiceClient();
async function callListSecrets() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = await secretmanagerClient.listSecretsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListSecrets();
`
Samples
Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.
| Sample | Source Code | Try it |
| --------------------------- | --------------------------------- | ------ |
| Secret_manager_service.access_secret_version | source code | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-secretmanager/samples/generated/v1/secret_manager_service.access_secret_version.js,packages/google-cloud-secretmanager/samples/README.md) |
| Secret_manager_service.add_secret_version | source code | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-secretmanager/samples/generated/v1/secret_manager_service.add_secret_version.js,packages/google-cloud-secretmanager/samples/README.md) |
| Secret_manager_service.create_secret | source code | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-secretmanager/samples/generated/v1/secret_manager_service.create_secret.js,packages/google-cloud-secretmanager/samples/README.md) |
| Secret_manager_service.delete_secret | source code | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-secretmanager/samples/generated/v1/secret_manager_service.delete_secret.js,packages/google-cloud-secretmanager/samples/README.md) |
| Secret_manager_service.destroy_secret_version | source code | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-secretmanager/samples/generated/v1/secret_manager_service.destroy_secret_version.js,packages/google-cloud-secretmanager/samples/README.md) |
| Secret_manager_service.disable_secret_version | source code | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-secretmanager/samples/generated/v1/secret_manager_service.disable_secret_version.js,packages/google-cloud-secretmanager/samples/README.md) |
| Secret_manager_service.enable_secret_version | source code | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-secretmanager/samples/generated/v1/secret_manager_service.enable_secret_version.js,packages/google-cloud-secretmanager/samples/README.md) |
| Secret_manager_service.get_iam_policy | source code | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-secretmanager/samples/generated/v1/secret_manager_service.get_iam_policy.js,packages/google-cloud-secretmanager/samples/README.md) |
| Secret_manager_service.get_secret | source code | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-secretmanager/samples/generated/v1/secret_manager_service.get_secret.js,packages/google-cloud-secretmanager/samples/README.md) |
| Secret_manager_service.get_secret_version | source code | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-secretmanager/samples/generated/v1/secret_manager_service.get_secret_version.js,packages/google-cloud-secretmanager/samples/README.md) |
| Secret_manager_service.list_secret_versions | source code | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-secretmanager/samples/generated/v1/secret_manager_service.list_secret_versions.js,packages/google-cloud-secretmanager/samples/README.md) |
| Secret_manager_service.list_secrets | source code | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-secretmanager/samples/generated/v1/secret_manager_service.list_secrets.js,packages/google-cloud-secretmanager/samples/README.md) |
| Secret_manager_service.set_iam_policy | source code | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-secretmanager/samples/generated/v1/secret_manager_service.set_iam_policy.js,packages/google-cloud-secretmanager/samples/README.md) |
| Secret_manager_service.test_iam_permissions | source code | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-secretmanager/samples/generated/v1/secret_manager_service.test_iam_permissions.js,packages/google-cloud-secretmanager/samples/README.md) |
| Secret_manager_service.update_secret | source code | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-secretmanager/samples/generated/v1/secret_manager_service.update_secret.js,packages/google-cloud-secretmanager/samples/README.md) |
| Secret_manager_service.access_secret_version | source code | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-secretmanager/samples/generated/v1beta2/secret_manager_service.access_secret_version.js,packages/google-cloud-secretmanager/samples/README.md) |
| Secret_manager_service.add_secret_version | source code | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-secretmanager/samples/generated/v1beta2/secret_manager_service.add_secret_version.js,packages/google-cloud-secretmanager/samples/README.md) |
| Secret_manager_service.create_secret | source code | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-secretmanager/samples/generated/v1beta2/secret_manager_service.create_secret.js,packages/google-cloud-secretmanager/samples/README.md) |
| Secret_manager_service.delete_secret | source code | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-secretmanager/samples/generated/v1beta2/secret_manager_service.delete_secret.js,packages/google-cloud-secretmanager/samples/README.md) |
| Secret_manager_service.destroy_secret_version | source code | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-secretmanager/samples/generated/v1beta2/secret_manager_service.destroy_secret_version.js,packages/google-cloud-secretmanager/samples/README.md) |
| Secret_manager_service.disable_secret_version | source code | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-secretmanager/samples/generated/v1beta2/secret_manager_service.disable_secret_version.js,packages/google-cloud-secretmanager/samples/README.md) |
| Secret_manager_service.enable_secret_version | source code | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-secretmanager/samples/generated/v1beta2/secret_manager_service.enable_secret_version.js,packages/google-cloud-secretmanager/samples/README.md) |
| Secret_manager_service.get_iam_policy | source code | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-secretmanager/samples/generated/v1beta2/secret_manager_service.get_iam_policy.js,packages/google-cloud-secretmanager/samples/README.md) |
| Secret_manager_service.get_secret | source code | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-secretmanager/samples/generated/v1beta2/secret_manager_service.get_secret.js,packages/google-cloud-secretmanager/samples/README.md) |
| Secret_manager_service.get_secret_version | source code | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-secretmanager/samples/generated/v1beta2/secret_manager_service.get_secret_version.js,packages/google-cloud-secretmanager/samples/README.md) |
| Secret_manager_service.list_secret_versions | source code | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-secretmanager/samples/generated/v1beta2/secret_manager_service.list_secret_versions.js,packages/google-cloud-secretmanager/samples/README.md) |
| Secret_manager_service.list_secrets | source code | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-secretmanager/samples/generated/v1beta2/secret_manager_service.list_secrets.js,packages/google-cloud-secretmanager/samples/README.md) |
| Secret_manager_service.set_iam_policy | source code | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-secretmanager/samples/generated/v1beta2/secret_manager_service.set_iam_policy.js,packages/google-cloud-secretmanager/samples/README.md) |
| Secret_manager_service.test_iam_permissions | source code | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-secretmanager/samples/generated/v1beta2/secret_manager_service.test_iam_permissions.js,packages/google-cloud-secretmanager/samples/README.md) |
| Secret_manager_service.update_secret | source code | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-secretmanager/samples/generated/v1beta2/secret_manager_service.update_secret.js,packages/google-cloud-secretmanager/samples/README.md) |
| Quickstart | source code | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-secretmanager/samples/quickstart.js,packages/google-cloud-secretmanager/samples/README.md) |
The [Secret Manager Node.js Client API Reference][client-docs] 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).npm install @google-cloud/secret-manager@legacy-8
For example, 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][launch_stages]
[launch_stages]: https://cloud.google.com/terms/launch-stages
Contributing
Contributions welcome! See the Contributing Guide.
Please note that this README.md, the samples/README.md,.nycrc
and a variety of configuration files in this repository (including 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
[client-docs]: https://cloud.google.com/nodejs/docs/reference/secret-manager/latest
[product-docs]: https://cloud.google.com/secret-manager/docs
[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png
[projects]: https://console.cloud.google.com/project
[billing]: https://support.google.com/cloud/answer/6293499#enable-billing
[enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=secretmanager.googleapis.com
[auth]: https://cloud.google.com/docs/authentication/external/set-up-adc-local