ContextQMD
Back to Google Cloud Node

[Security Command Center API: Nodejs Client][homepage]

packages/google-cloud-securitycenter/README.md

0.57.034.9 KB
Original Source

Security Command Center API: Nodejs Client

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

Security Command Center API client for Node.js

Node.js idiomatic client for [Cloud Security Command Center][product-docs].

Cloud Security Command Center helps security teams gather data, identify threats, and act on them before they result in business damage or loss. It offers deep insight into application and data risk so that you can quickly mitigate threats to your cloud resources and evaluate overall health. With Cloud Security Command Center, you can view and monitor an inventory of your cloud assets, scan storage systems for sensitive data, detect common web vulnerabilities, and review access rights to your critical resources, all from a single, centralized dashboard.

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 Security Command Center API API.
  4. Set up authentication so you can access the API from your local workstation.

Installing the client library

bash
npm install @google-cloud/security-center

Samples

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

SampleSource Code
batch create resource value configssource code
bulk mute findingssource code
create big query exportsource code
create event threat detection custom modulesource code
create findingsource code
create mute configsource code
create notification configsource code
create security health analytics custom modulesource code
create sourcesource code
delete big query exportsource code
delete event threat detection custom modulesource code
delete mute configsource code
delete notification configsource code
delete resource value configsource code
delete security health analytics custom modulesource code
get big query exportsource code
get effective event threat detection custom modulesource code
get effective security health analytics custom modulesource code
get event threat detection custom modulesource code
get iam policysource code
get mute configsource code
get notification configsource code
get organization settingssource code
get resource value configsource code
get security health analytics custom modulesource code
get simulationsource code
get sourcesource code
get valued resourcesource code
group assetssource code
group findingssource code
list assetssource code
list attack pathssource code
list big query exportssource code
list descendant event threat detection custom modulessource code
list descendant security health analytics custom modulessource code
list effective event threat detection custom modulessource code
list effective security health analytics custom modulessource code
list event threat detection custom modulessource code
list findingssource code
list mute configssource code
list notification configssource code
list resource value configssource code
list security health analytics custom modulessource code
list sourcessource code
list valued resourcessource code
run asset discoverysource code
set finding statesource code
set iam policysource code
set mutesource code
simulate security health analytics custom modulesource code
test iam permissionssource code
update big query exportsource code
update event threat detection custom modulesource code
update external systemsource code
update findingsource code
update mute configsource code
update notification configsource code
update organization settingssource code
update resource value configsource code
update security health analytics custom modulesource code
update security markssource code
update sourcesource code
validate event threat detection custom modulesource code
cloudsource code
create findingsource code
create sourcesource code
get iam policysource code
get organization settingssource code
get sourcesource code
group assetssource code
group findingssource code
list assetssource code
list findingssource code
list sourcessource code
run asset discoverysource code
set finding statesource code
set iam policysource code
test iam permissionssource code
update findingsource code
update organization settingssource code
update security markssource code
update sourcesource code
cloudsource code
create findingsource code
create notification configsource code
create sourcesource code
delete notification configsource code
get iam policysource code
get notification configsource code
get organization settingssource code
get sourcesource code
group assetssource code
group findingssource code
list assetssource code
list findingssource code
list notification configssource code
list sourcessource code
run asset discoverysource code
set finding statesource code
set iam policysource code
test iam permissionssource code
update findingsource code
update notification configsource code
update organization settingssource code
update security markssource code
update sourcesource code
cloudsource code
batch create resource value configssource code
bulk mute findingssource code
create big query exportsource code
create findingsource code
create mute configsource code
create notification configsource code
create sourcesource code
delete big query exportsource code
delete mute configsource code
delete notification configsource code
delete resource value configsource code
get big query exportsource code
get iam policysource code
get mute configsource code
get notification configsource code
get resource value configsource code
get simulationsource code
get sourcesource code
get valued resourcesource code
group findingssource code
list attack pathssource code
list big query exportssource code
list findingssource code
list mute configssource code
list notification configssource code
list resource value configssource code
list sourcessource code
list valued resourcessource code
set finding statesource code
set iam policysource code
set mutesource code
test iam permissionssource code
update big query exportsource code
update external systemsource code
update findingsource code
update mute configsource code
update notification configsource code
update resource value configsource code
update security markssource code
update sourcesource code
cloudsource code

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.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

Please note that this README.md and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template.

License

Apache Version 2.0

See LICENSE