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
- Select or create a Cloud Platform project.
- Enable billing for your project.
- Enable the Security Command Center API API.
- Set up authentication so you can access the API from your local workstation. ### Installing the client library
npm install @google-cloud/security-center
Samples
Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.
| Sample | Source Code |
|---|---|
| batch create resource value configs | source code |
| bulk mute findings | source code |
| create big query export | source code |
| create event threat detection custom module | source code |
| create finding | source code |
| create mute config | source code |
| create notification config | source code |
| create security health analytics custom module | source code |
| create source | source code |
| delete big query export | source code |
| delete event threat detection custom module | source code |
| delete mute config | source code |
| delete notification config | source code |
| delete resource value config | source code |
| delete security health analytics custom module | source code |
| get big query export | source code |
| get effective event threat detection custom module | source code |
| get effective security health analytics custom module | source code |
| get event threat detection custom module | source code |
| get iam policy | source code |
| get mute config | source code |
| get notification config | source code |
| get organization settings | source code |
| get resource value config | source code |
| get security health analytics custom module | source code |
| get simulation | source code |
| get source | source code |
| get valued resource | source code |
| group assets | source code |
| group findings | source code |
| list assets | source code |
| list attack paths | source code |
| list big query exports | source code |
| list descendant event threat detection custom modules | source code |
| list descendant security health analytics custom modules | source code |
| list effective event threat detection custom modules | source code |
| list effective security health analytics custom modules | source code |
| list event threat detection custom modules | source code |
| list findings | source code |
| list mute configs | source code |
| list notification configs | source code |
| list resource value configs | source code |
| list security health analytics custom modules | source code |
| list sources | source code |
| list valued resources | source code |
| run asset discovery | source code |
| set finding state | source code |
| set iam policy | source code |
| set mute | source code |
| simulate security health analytics custom module | source code |
| test iam permissions | source code |
| update big query export | source code |
| update event threat detection custom module | source code |
| update external system | source code |
| update finding | source code |
| update mute config | source code |
| update notification config | source code |
| update organization settings | source code |
| update resource value config | source code |
| update security health analytics custom module | source code |
| update security marks | source code |
| update source | source code |
| validate event threat detection custom module | source code |
| cloud | source code |
| create finding | source code |
| create source | source code |
| get iam policy | source code |
| get organization settings | source code |
| get source | source code |
| group assets | source code |
| group findings | source code |
| list assets | source code |
| list findings | source code |
| list sources | source code |
| run asset discovery | source code |
| set finding state | source code |
| set iam policy | source code |
| test iam permissions | source code |
| update finding | source code |
| update organization settings | source code |
| update security marks | source code |
| update source | source code |
| cloud | source code |
| create finding | source code |
| create notification config | source code |
| create source | source code |
| delete notification config | source code |
| get iam policy | source code |
| get notification config | source code |
| get organization settings | source code |
| get source | source code |
| group assets | source code |
| group findings | source code |
| list assets | source code |
| list findings | source code |
| list notification configs | source code |
| list sources | source code |
| run asset discovery | source code |
| set finding state | source code |
| set iam policy | source code |
| test iam permissions | source code |
| update finding | source code |
| update notification config | source code |
| update organization settings | source code |
| update security marks | source code |
| update source | source code |
| cloud | source code |
| batch create resource value configs | source code |
| bulk mute findings | source code |
| create big query export | source code |
| create finding | source code |
| create mute config | source code |
| create notification config | source code |
| create source | source code |
| delete big query export | source code |
| delete mute config | source code |
| delete notification config | source code |
| delete resource value config | source code |
| get big query export | source code |
| get iam policy | source code |
| get mute config | source code |
| get notification config | source code |
| get resource value config | source code |
| get simulation | source code |
| get source | source code |
| get valued resource | source code |
| group findings | source code |
| list attack paths | source code |
| list big query exports | source code |
| list findings | source code |
| list mute configs | source code |
| list notification configs | source code |
| list resource value configs | source code |
| list sources | source code |
| list valued resources | source code |
| set finding state | source code |
| set iam policy | source code |
| set mute | source code |
| test iam permissions | source code |
| update big query export | source code |
| update external system | source code |
| update finding | source code |
| update mute config | source code |
| update notification config | source code |
| update resource value config | source code |
| update security marks | source code |
| update source | source code |
| cloud | source 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