Security Center Management API: Node.js Client

Security Center Management 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
Samples
Versioning
Contributing
License

Quickstart

Before you begin

Select or create a Cloud Platform project.
Enable billing for your project.
Enable the Security Center Management API API.
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/securitycentermanagement

Using the client library

/**
 * 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. Name of parent to list effective custom modules. Its format is
 *  "organizations/{organization}/locations/{location}",
 *  "folders/{folder}/locations/{location}",
 *  or
 *  "projects/{project}/locations/{location}"
 */
// const parent = 'abc123'
/**
 *  Optional. The maximum number of results to return in a single response.
 *  Default is 10, minimum is 1, maximum is 1000.
 */
// const pageSize = 1234
/**
 *  Optional. The value returned by the last call indicating a continuation
 */
// const pageToken = 'abc123'

// Imports the Securitycentermanagement library
const {SecurityCenterManagementClient} =
  require('@google-cloud/securitycentermanagement').v1;

// Instantiates a client
const securitycentermanagementClient = new SecurityCenterManagementClient();

async function callListEffectiveEventThreatDetectionCustomModules() {
  // Construct request
  const request = {
    parent,
  };

  // Run request
  const iterable =
    securitycentermanagementClient.listEffectiveEventThreatDetectionCustomModulesAsync(
      request
    );
  for await (const response of iterable) {
    console.log(response);
  }
}

callListEffectiveEventThreatDetectionCustomModules();

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_management.create_event_threat_detection_custom_module	source code
Security_center_management.create_security_health_analytics_custom_module	source code
Security_center_management.delete_event_threat_detection_custom_module	source code
Security_center_management.delete_security_health_analytics_custom_module	source code
Security_center_management.get_effective_event_threat_detection_custom_module	source code
Security_center_management.get_effective_security_health_analytics_custom_module	source code
Security_center_management.get_event_threat_detection_custom_module	source code
Security_center_management.get_security_center_service	source code
Security_center_management.get_security_health_analytics_custom_module	source code
Security_center_management.list_descendant_event_threat_detection_custom_modules	source code
Security_center_management.list_descendant_security_health_analytics_custom_modules	source code
Security_center_management.list_effective_event_threat_detection_custom_modules	source code
Security_center_management.list_effective_security_health_analytics_custom_modules	source code
Security_center_management.list_event_threat_detection_custom_modules	source code
Security_center_management.list_security_center_services	source code
Security_center_management.list_security_health_analytics_custom_modules	source code
Security_center_management.simulate_security_health_analytics_custom_module	source code
Security_center_management.update_event_threat_detection_custom_module	source code
Security_center_management.update_security_center_service	source code
Security_center_management.update_security_health_analytics_custom_module	source code
Security_center_management.validate_event_threat_detection_custom_module	source code
Quickstart	source code

The Security Center Management API 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/securitycentermanagement@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