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 Referenceclient-docs
- Google Cloud Security Command Center Documentationproduct-docs
- 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 Explainedexplained.
Table of contents:
Before you begin Installing the client library Using the client library
Quickstart
Before you begin
- Select or create a Cloud Platform projectprojects.
- Enable billing for your projectbilling.
- Enable the Google Cloud Security Command Center APIenableapi.
- Set up authentication with a service accountauth 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 organization to use
// const organization = 'your-organization';
const [source] = await client.createSource({
parent: client.organizationPath(organization),
source: {},
});
// The newly created source.
console.log('Source created.');
console.log(source);
}
quickstart();
Samples
Samples are in thesamples/
directory. Each sample's README.md
has instructions for running its sample.| Sample | Source Code | Try it | | --------------------------- | --------------------------------- | ------ | | Securitycenter.bulkmutefindings | source code | !Open in Cloud Shellshellimg | | Securitycenter.createbigqueryexport | source code | !Open in Cloud Shellshellimg | | Securitycenter.createfinding | source code | !Open in Cloud Shellshellimg | | Securitycenter.createmuteconfig | source code | !Open in Cloud Shellshellimg | | Securitycenter.createnotificationconfig | source code | !Open in Cloud Shellshellimg | | Securitycenter.createsource | source code | !Open in Cloud Shellshellimg | | Securitycenter.deletebigqueryexport | source code | !Open in Cloud Shellshellimg | | Securitycenter.deletemuteconfig | source code | !Open in Cloud Shellshellimg | | Securitycenter.deletenotificationconfig | source code | !Open in Cloud Shellshellimg | | Securitycenter.getbigqueryexport | source code | !Open in Cloud Shellshellimg | | Securitycenter.getiampolicy | source code | !Open in Cloud Shellshellimg | | Securitycenter.getmuteconfig | source code | !Open in Cloud Shellshellimg | | Securitycenter.getnotificationconfig | source code | !Open in Cloud Shellshellimg | | Securitycenter.getorganizationsettings | source code | !Open in Cloud Shellshellimg | | Securitycenter.getsource | source code | !Open in Cloud Shellshellimg | | Securitycenter.groupassets | source code | !Open in Cloud Shellshellimg | | Securitycenter.groupfindings | source code | !Open in Cloud Shellshellimg | | Securitycenter.listassets | source code | !Open in Cloud Shellshellimg | | Securitycenter.listbigqueryexports | source code | !Open in Cloud Shellshellimg | | Securitycenter.listfindings | source code | !Open in Cloud Shellshellimg | | Securitycenter.listmuteconfigs | source code | !Open in Cloud Shellshellimg | | Securitycenter.listnotificationconfigs | source code | !Open in Cloud Shellshellimg | | Securitycenter.listsources | source code | !Open in Cloud Shellshellimg | | Securitycenter.runassetdiscovery | source code | !Open in Cloud Shellshellimg | | Securitycenter.setfindingstate | source code | !Open in Cloud Shellshellimg | | Securitycenter.setiampolicy | source code | !Open in Cloud Shellshellimg | | Securitycenter.setmute | source code | !Open in Cloud Shellshellimg | | Securitycenter.testiampermissions | source code | !Open in Cloud Shellshellimg | | Securitycenter.updatebigqueryexport | source code | !Open in Cloud Shellshellimg | | Securitycenter.updateexternalsystem | source code | !Open in Cloud Shellshellimg | | Securitycenter.updatefinding | source code | !Open in Cloud Shellshellimg | | Securitycenter.updatemuteconfig | source code | !Open in Cloud Shellshellimg | | Securitycenter.updatenotificationconfig | source code | !Open in Cloud Shellshellimg | | Securitycenter.updateorganizationsettings | source code | !Open in Cloud Shellshellimg | | Securitycenter.updatesecuritymarks | source code | !Open in Cloud Shellshellimg | | Securitycenter.updatesource | source code | !Open in Cloud Shellshellimg | | Securitycenter.createfinding | source code | !Open in Cloud Shellshellimg | | Securitycenter.createsource | source code | !Open in Cloud Shellshellimg | | Securitycenter.getiampolicy | source code | !Open in Cloud Shellshellimg | | Securitycenter.getorganizationsettings | source code | !Open in Cloud Shellshellimg | | Securitycenter.getsource | source code | !Open in Cloud Shellshellimg | | Securitycenter.groupassets | source code | !Open in Cloud Shellshellimg | | Securitycenter.groupfindings | source code | !Open in Cloud Shellshellimg | | Securitycenter.listassets | source code | !Open in Cloud Shellshellimg | | Securitycenter.listfindings | source code | !Open in Cloud Shellshellimg | | Securitycenter.listsources | source code | !Open in Cloud Shellshellimg | | Securitycenter.runassetdiscovery | source code | !Open in Cloud Shellshellimg | | Securitycenter.setfindingstate | source code | !Open in Cloud Shellshellimg | | Securitycenter.setiampolicy | source code | !Open in Cloud Shellshellimg | | Securitycenter.testiampermissions | source code | !Open in Cloud Shellshellimg | | Securitycenter.updatefinding | source code | !Open in Cloud Shellshellimg | | Securitycenter.updateorganizationsettings | source code | !Open in Cloud Shellshellimg | | Securitycenter.updatesecuritymarks | source code | !Open in Cloud Shellshellimg | | Securitycenter.updatesource | source code | !Open in Cloud Shellshellimg | | Securitycenter.createfinding | source code | !Open in Cloud Shellshellimg | | Securitycenter.createnotificationconfig | source code | !Open in Cloud Shellshellimg | | Securitycenter.createsource | source code | !Open in Cloud Shellshellimg | | Securitycenter.deletenotificationconfig | source code | !Open in Cloud Shellshellimg | | Securitycenter.getiampolicy | source code | !Open in Cloud Shellshellimg | | Securitycenter.getnotificationconfig | source code | !Open in Cloud Shellshellimg | | Securitycenter.getorganizationsettings | source code | !Open in Cloud Shellshellimg | | Securitycenter.getsource | source code | !Open in Cloud Shellshellimg | | Securitycenter.groupassets | source code | !Open in Cloud Shellshellimg | | Securitycenter.groupfindings | source code | !Open in Cloud Shellshellimg | | Securitycenter.listassets | source code | !Open in Cloud Shellshellimg | | Securitycenter.listfindings | source code | !Open in Cloud Shellshellimg | | Securitycenter.listnotificationconfigs | source code | !Open in Cloud Shellshellimg | | Securitycenter.listsources | source code | !Open in Cloud Shellshellimg | | Securitycenter.runassetdiscovery | source code | !Open in Cloud Shellshellimg | | Securitycenter.setfindingstate | source code | !Open in Cloud Shellshellimg | | Securitycenter.setiampolicy | source code | !Open in Cloud Shellshellimg | | Securitycenter.testiampermissions | source code | !Open in Cloud Shellshellimg | | Securitycenter.updatefinding | source code | !Open in Cloud Shellshellimg | | Securitycenter.updatenotificationconfig | source code | !Open in Cloud Shellshellimg | | Securitycenter.updateorganizationsettings | source code | !Open in Cloud Shellshellimg | | Securitycenter.updatesecuritymarks | source code | !Open in Cloud Shellshellimg | | Securitycenter.updatesource | source code | !Open in Cloud Shellshellimg | | Quickstart | source code | !Open in Cloud Shellshellimg | | Quickstart.test | source code | !Open in Cloud Shellshellimg |
The Google Cloud Security Command Center Node.js Client API Referenceclient-docs 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 Stageslaunchstages
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.0See LICENSE