This library is considered to be in preview. This means it is still a work-in-progress and under active development. Any release is subject to backwards-incompatible changes at any time.
Cloud Security Compliance API client for Node.js
A comprehensive list of changes in each version may be found in the CHANGELOG.
- Cloud Security Compliance API Nodejs Client API Reference
- Cloud Security Compliance API Documentation
Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.
Table of contents:
- Select or create a Cloud Platform project.
- Enable billing for your project.
- Enable the Cloud Security Compliance API API.
- Set up authentication so you can access the API from your local workstation.
npm install @google-cloud/cloudsecuritycomplianceSamples are in the samples/ directory. Each sample's README.md has instructions for running its sample.
| Sample | Source Code |
|---|---|
| create framework audit | source code |
| generate framework audit scope report | source code |
| get framework audit | source code |
| list framework audits | source code |
| calculate effective cm enrollment | source code |
| update cm enrollment | source code |
| create cloud control | source code |
| create framework | source code |
| delete cloud control | source code |
| delete framework | source code |
| get cloud control | source code |
| get framework | source code |
| list cloud controls | source code |
| list frameworks | source code |
| update cloud control | source code |
| update framework | source code |
| create framework deployment | source code |
| delete framework deployment | source code |
| get cloud control deployment | source code |
| get framework deployment | source code |
| list cloud control deployments | source code |
| list framework deployments | source code |
| aggregate framework compliance report | source code |
| fetch framework compliance report | source code |
| list control compliance summaries | source code |
| list finding summaries | source code |
| list framework compliance summaries | source code |
| cloud | source code |
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/cloudsecuritycompliance@legacy-8 installs client libraries
for versions compatible with Node.js 8.
This library follows Semantic Versioning.
More Information: Google Cloud Platform Launch Stages
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.
Apache Version 2.0
See LICENSE