@google-cloud/security-private-ca
TypeScript icon, indicating that this package has built-in type declarations

5.2.0 • Public • Published

Google Cloud Platform logo

release level npm version

Privateca 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 Certificate Authority 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/security-private-ca

Using the client library

// Imports the Google Cloud client library

const {
  CertificateAuthorityServiceClient,
} = require('@google-cloud/security-private-ca');

// TODO(developer): replace with your prefered project ID.
// const projectId = 'my-project'

// Creates a client
const client = new CertificateAuthorityServiceClient();

async function listCertificates() {
  const res = await client.listCertificates({
    parent: `projects/${projectId}/locations/${location}/caPools/${name}`,
  });
  return res;
}

listCertificates();

Samples

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

Sample Source Code Try it
Certificate_authority_service.activate_certificate_authority source code Open in Cloud Shell
Certificate_authority_service.create_ca_pool source code Open in Cloud Shell
Certificate_authority_service.create_certificate source code Open in Cloud Shell
Certificate_authority_service.create_certificate_authority source code Open in Cloud Shell
Certificate_authority_service.create_certificate_template source code Open in Cloud Shell
Certificate_authority_service.delete_ca_pool source code Open in Cloud Shell
Certificate_authority_service.delete_certificate_authority source code Open in Cloud Shell
Certificate_authority_service.delete_certificate_template source code Open in Cloud Shell
Certificate_authority_service.disable_certificate_authority source code Open in Cloud Shell
Certificate_authority_service.enable_certificate_authority source code Open in Cloud Shell
Certificate_authority_service.fetch_ca_certs source code Open in Cloud Shell
Certificate_authority_service.fetch_certificate_authority_csr source code Open in Cloud Shell
Certificate_authority_service.get_ca_pool source code Open in Cloud Shell
Certificate_authority_service.get_certificate source code Open in Cloud Shell
Certificate_authority_service.get_certificate_authority source code Open in Cloud Shell
Certificate_authority_service.get_certificate_revocation_list source code Open in Cloud Shell
Certificate_authority_service.get_certificate_template source code Open in Cloud Shell
Certificate_authority_service.list_ca_pools source code Open in Cloud Shell
Certificate_authority_service.list_certificate_authorities source code Open in Cloud Shell
Certificate_authority_service.list_certificate_revocation_lists source code Open in Cloud Shell
Certificate_authority_service.list_certificate_templates source code Open in Cloud Shell
Certificate_authority_service.list_certificates source code Open in Cloud Shell
Certificate_authority_service.revoke_certificate source code Open in Cloud Shell
Certificate_authority_service.undelete_certificate_authority source code Open in Cloud Shell
Certificate_authority_service.update_ca_pool source code Open in Cloud Shell
Certificate_authority_service.update_certificate source code Open in Cloud Shell
Certificate_authority_service.update_certificate_authority source code Open in Cloud Shell
Certificate_authority_service.update_certificate_revocation_list source code Open in Cloud Shell
Certificate_authority_service.update_certificate_template source code Open in Cloud Shell
Certificate_authority_service.activate_certificate_authority source code Open in Cloud Shell
Certificate_authority_service.create_certificate source code Open in Cloud Shell
Certificate_authority_service.create_certificate_authority source code Open in Cloud Shell
Certificate_authority_service.disable_certificate_authority source code Open in Cloud Shell
Certificate_authority_service.enable_certificate_authority source code Open in Cloud Shell
Certificate_authority_service.fetch_certificate_authority_csr source code Open in Cloud Shell
Certificate_authority_service.get_certificate source code Open in Cloud Shell
Certificate_authority_service.get_certificate_authority source code Open in Cloud Shell
Certificate_authority_service.get_certificate_revocation_list source code Open in Cloud Shell
Certificate_authority_service.get_reusable_config source code Open in Cloud Shell
Certificate_authority_service.list_certificate_authorities source code Open in Cloud Shell
Certificate_authority_service.list_certificate_revocation_lists source code Open in Cloud Shell
Certificate_authority_service.list_certificates source code Open in Cloud Shell
Certificate_authority_service.list_reusable_configs source code Open in Cloud Shell
Certificate_authority_service.restore_certificate_authority source code Open in Cloud Shell
Certificate_authority_service.revoke_certificate source code Open in Cloud Shell
Certificate_authority_service.schedule_delete_certificate_authority source code Open in Cloud Shell
Certificate_authority_service.update_certificate source code Open in Cloud Shell
Certificate_authority_service.update_certificate_authority source code Open in Cloud Shell
Certificate_authority_service.update_certificate_revocation_list source code Open in Cloud Shell
Quickstart source code Open in Cloud Shell

The Certificate Authority Service 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/security-private-ca@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

Package Sidebar

Install

npm i @google-cloud/security-private-ca

Weekly Downloads

746

Version

5.2.0

License

Apache-2.0

Unpacked Size

6.74 MB

Total Files

23

Last publish

Collaborators

  • google-wombot
  • google-admin