@google-cloud/security-center

Google Cloud Security Command Center: Node.js Client

Cloud Security Command Center API client for Node.js

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

• Google Cloud Security Command Center Node.js Client API Reference
• Google Cloud Security Command Center Documentation
• github.com/googleapis/google-cloud-node/packages/google-cloud-securitycenter

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
  • Installing the client library
  • Using the client library
• Samples
• Versioning
• Contributing
• License

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.

Sample	Source Code	Try it
Security_center.batch_create_resource_value_configs	source code
Security_center.bulk_mute_findings	source code
Security_center.create_big_query_export	source code
Security_center.create_event_threat_detection_custom_module	source code
Security_center.create_finding	source code
Security_center.create_mute_config	source code
Security_center.create_notification_config	source code
Security_center.create_security_health_analytics_custom_module	source code
Security_center.create_source	source code
Security_center.delete_big_query_export	source code
Security_center.delete_event_threat_detection_custom_module	source code
Security_center.delete_mute_config	source code
Security_center.delete_notification_config	source code
Security_center.delete_resource_value_config	source code
Security_center.delete_security_health_analytics_custom_module	source code
Security_center.get_big_query_export	source code
Security_center.get_effective_event_threat_detection_custom_module	source code
Security_center.get_effective_security_health_analytics_custom_module	source code
Security_center.get_event_threat_detection_custom_module	source code
Security_center.get_iam_policy	source code
Security_center.get_mute_config	source code
Security_center.get_notification_config	source code
Security_center.get_organization_settings	source code
Security_center.get_resource_value_config	source code
Security_center.get_security_health_analytics_custom_module	source code
Security_center.get_simulation	source code
Security_center.get_source	source code
Security_center.get_valued_resource	source code
Security_center.group_assets	source code
Security_center.group_findings	source code
Security_center.list_assets	source code
Security_center.list_attack_paths	source code
Security_center.list_big_query_exports	source code
Security_center.list_descendant_event_threat_detection_custom_modules	source code
Security_center.list_descendant_security_health_analytics_custom_modules	source code
Security_center.list_effective_event_threat_detection_custom_modules	source code
Security_center.list_effective_security_health_analytics_custom_modules	source code
Security_center.list_event_threat_detection_custom_modules	source code
Security_center.list_findings	source code
Security_center.list_mute_configs	source code
Security_center.list_notification_configs	source code
Security_center.list_resource_value_configs	source code
Security_center.list_security_health_analytics_custom_modules	source code
Security_center.list_sources	source code
Security_center.list_valued_resources	source code
Security_center.run_asset_discovery	source code
Security_center.set_finding_state	source code
Security_center.set_iam_policy	source code
Security_center.set_mute	source code
Security_center.simulate_security_health_analytics_custom_module	source code
Security_center.test_iam_permissions	source code
Security_center.update_big_query_export	source code
Security_center.update_event_threat_detection_custom_module	source code
Security_center.update_external_system	source code
Security_center.update_finding	source code
Security_center.update_mute_config	source code
Security_center.update_notification_config	source code
Security_center.update_organization_settings	source code
Security_center.update_resource_value_config	source code
Security_center.update_security_health_analytics_custom_module	source code
Security_center.update_security_marks	source code
Security_center.update_source	source code
Security_center.validate_event_threat_detection_custom_module	source code
Security_center.create_finding	source code
Security_center.create_source	source code
Security_center.get_iam_policy	source code
Security_center.get_organization_settings	source code
Security_center.get_source	source code
Security_center.group_assets	source code
Security_center.group_findings	source code
Security_center.list_assets	source code
Security_center.list_findings	source code
Security_center.list_sources	source code
Security_center.run_asset_discovery	source code
Security_center.set_finding_state	source code
Security_center.set_iam_policy	source code
Security_center.test_iam_permissions	source code
Security_center.update_finding	source code
Security_center.update_organization_settings	source code
Security_center.update_security_marks	source code
Security_center.update_source	source code
Security_center.create_finding	source code
Security_center.create_notification_config	source code
Security_center.create_source	source code
Security_center.delete_notification_config	source code
Security_center.get_iam_policy	source code
Security_center.get_notification_config	source code
Security_center.get_organization_settings	source code
Security_center.get_source	source code
Security_center.group_assets	source code
Security_center.group_findings	source code
Security_center.list_assets	source code
Security_center.list_findings	source code
Security_center.list_notification_configs	source code
Security_center.list_sources	source code
Security_center.run_asset_discovery	source code
Security_center.set_finding_state	source code
Security_center.set_iam_policy	source code
Security_center.test_iam_permissions	source code
Security_center.update_finding	source code
Security_center.update_notification_config	source code
Security_center.update_organization_settings	source code
Security_center.update_security_marks	source code
Security_center.update_source	source code
Security_center.batch_create_resource_value_configs	source code
Security_center.bulk_mute_findings	source code
Security_center.create_big_query_export	source code
Security_center.create_finding	source code
Security_center.create_mute_config	source code
Security_center.create_notification_config	source code
Security_center.create_source	source code
Security_center.delete_big_query_export	source code
Security_center.delete_mute_config	source code
Security_center.delete_notification_config	source code
Security_center.delete_resource_value_config	source code
Security_center.get_big_query_export	source code
Security_center.get_iam_policy	source code
Security_center.get_mute_config	source code
Security_center.get_notification_config	source code
Security_center.get_resource_value_config	source code
Security_center.get_simulation	source code
Security_center.get_source	source code
Security_center.get_valued_resource	source code
Security_center.group_findings	source code
Security_center.list_attack_paths	source code
Security_center.list_big_query_exports	source code
Security_center.list_findings	source code
Security_center.list_mute_configs	source code
Security_center.list_notification_configs	source code
Security_center.list_resource_value_configs	source code
Security_center.list_sources	source code
Security_center.list_valued_resources	source code
Security_center.set_finding_state	source code
Security_center.set_iam_policy	source code
Security_center.set_mute	source code
Security_center.test_iam_permissions	source code
Security_center.update_big_query_export	source code
Security_center.update_external_system	source code
Security_center.update_finding	source code
Security_center.update_mute_config	source code
Security_center.update_notification_config	source code
Security_center.update_resource_value_config	source code
Security_center.update_security_marks	source code
Security_center.update_source	source code
Quickstart	source code

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