Google Cloud Security Command Center: Node.js Client

release level npm version

Cloud Security Command Center 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 Security Command Center 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-center

Using the client library

const sc = require('@google-cloud/security-center');

// Create a client
const client = new sc.SecurityCenterClient();

async function quickstart() {
  // TODO(developer): choose the project to use
  // const project = 'your-project';

  if (!project) {
    project = await client.getProjectId();
  }

  let counter = 0;
  for await (const source of client.listSourcesAsync({
    parent: `projects/${project}`,
  })) {
    ++counter;
    console.log(source);
  }
  console.log(`${counter} sources listed.`);
}
quickstart();

Samples

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

SampleSource CodeTry it
Security_center.bulk_mute_findingssource codeOpen in Cloud Shell
Security_center.create_big_query_exportsource codeOpen in Cloud Shell
Security_center.create_findingsource codeOpen in Cloud Shell
Security_center.create_mute_configsource codeOpen in Cloud Shell
Security_center.create_notification_configsource codeOpen in Cloud Shell
Security_center.create_security_health_analytics_custom_modulesource codeOpen in Cloud Shell
Security_center.create_sourcesource codeOpen in Cloud Shell
Security_center.delete_big_query_exportsource codeOpen in Cloud Shell
Security_center.delete_mute_configsource codeOpen in Cloud Shell
Security_center.delete_notification_configsource codeOpen in Cloud Shell
Security_center.delete_security_health_analytics_custom_modulesource codeOpen in Cloud Shell
Security_center.get_big_query_exportsource codeOpen in Cloud Shell
Security_center.get_effective_security_health_analytics_custom_modulesource codeOpen in Cloud Shell
Security_center.get_iam_policysource codeOpen in Cloud Shell
Security_center.get_mute_configsource codeOpen in Cloud Shell
Security_center.get_notification_configsource codeOpen in Cloud Shell
Security_center.get_organization_settingssource codeOpen in Cloud Shell
Security_center.get_security_health_analytics_custom_modulesource codeOpen in Cloud Shell
Security_center.get_sourcesource codeOpen in Cloud Shell
Security_center.group_assetssource codeOpen in Cloud Shell
Security_center.group_findingssource codeOpen in Cloud Shell
Security_center.list_assetssource codeOpen in Cloud Shell
Security_center.list_big_query_exportssource codeOpen in Cloud Shell
Security_center.list_descendant_security_health_analytics_custom_modulessource codeOpen in Cloud Shell
Security_center.list_effective_security_health_analytics_custom_modulessource codeOpen in Cloud Shell
Security_center.list_findingssource codeOpen in Cloud Shell
Security_center.list_mute_configssource codeOpen in Cloud Shell
Security_center.list_notification_configssource codeOpen in Cloud Shell
Security_center.list_security_health_analytics_custom_modulessource codeOpen in Cloud Shell
Security_center.list_sourcessource codeOpen in Cloud Shell
Security_center.run_asset_discoverysource codeOpen in Cloud Shell
Security_center.set_finding_statesource codeOpen in Cloud Shell
Security_center.set_iam_policysource codeOpen in Cloud Shell
Security_center.set_mutesource codeOpen in Cloud Shell
Security_center.simulate_security_health_analytics_custom_modulesource codeOpen in Cloud Shell
Security_center.test_iam_permissionssource codeOpen in Cloud Shell
Security_center.update_big_query_exportsource codeOpen in Cloud Shell
Security_center.update_external_systemsource codeOpen in Cloud Shell
Security_center.update_findingsource codeOpen in Cloud Shell
Security_center.update_mute_configsource codeOpen in Cloud Shell
Security_center.update_notification_configsource codeOpen in Cloud Shell
Security_center.update_organization_settingssource codeOpen in Cloud Shell
Security_center.update_security_health_analytics_custom_modulesource codeOpen in Cloud Shell
Security_center.update_security_markssource codeOpen in Cloud Shell
Security_center.update_sourcesource codeOpen in Cloud Shell
Security_center.create_findingsource codeOpen in Cloud Shell
Security_center.create_sourcesource codeOpen in Cloud Shell
Security_center.get_iam_policysource codeOpen in Cloud Shell
Security_center.get_organization_settingssource codeOpen in Cloud Shell
Security_center.get_sourcesource codeOpen in Cloud Shell
Security_center.group_assetssource codeOpen in Cloud Shell
Security_center.group_findingssource codeOpen in Cloud Shell
Security_center.list_assetssource codeOpen in Cloud Shell
Security_center.list_findingssource codeOpen in Cloud Shell
Security_center.list_sourcessource codeOpen in Cloud Shell
Security_center.run_asset_discoverysource codeOpen in Cloud Shell
Security_center.set_finding_statesource codeOpen in Cloud Shell
Security_center.set_iam_policysource codeOpen in Cloud Shell
Security_center.test_iam_permissionssource codeOpen in Cloud Shell
Security_center.update_findingsource codeOpen in Cloud Shell
Security_center.update_organization_settingssource codeOpen in Cloud Shell
Security_center.update_security_markssource codeOpen in Cloud Shell
Security_center.update_sourcesource codeOpen in Cloud Shell
Security_center.create_findingsource codeOpen in Cloud Shell
Security_center.create_notification_configsource codeOpen in Cloud Shell
Security_center.create_sourcesource codeOpen in Cloud Shell
Security_center.delete_notification_configsource codeOpen in Cloud Shell
Security_center.get_iam_policysource codeOpen in Cloud Shell
Security_center.get_notification_configsource codeOpen in Cloud Shell
Security_center.get_organization_settingssource codeOpen in Cloud Shell
Security_center.get_sourcesource codeOpen in Cloud Shell
Security_center.group_assetssource codeOpen in Cloud Shell
Security_center.group_findingssource codeOpen in Cloud Shell
Security_center.list_assetssource codeOpen in Cloud Shell
Security_center.list_findingssource codeOpen in Cloud Shell
Security_center.list_notification_configssource codeOpen in Cloud Shell
Security_center.list_sourcessource codeOpen in Cloud Shell
Security_center.run_asset_discoverysource codeOpen in Cloud Shell
Security_center.set_finding_statesource codeOpen in Cloud Shell
Security_center.set_iam_policysource codeOpen in Cloud Shell
Security_center.test_iam_permissionssource codeOpen in Cloud Shell
Security_center.update_findingsource codeOpen in Cloud Shell
Security_center.update_notification_configsource codeOpen in Cloud Shell
Security_center.update_organization_settingssource codeOpen in Cloud Shell
Security_center.update_security_markssource codeOpen in Cloud Shell
Security_center.update_sourcesource codeOpen in Cloud Shell
Quickstartsource codeOpen in Cloud Shell

The Google Cloud Security Command Center 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-center@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