@google-cloud/access-context-manager

Access Context Manager: Node.js Client

accesscontextmanager client for Node.js

A comprehensive list of changes in each version may be found in the CHANGELOG.

• Access Context Manager Node.js Client API Reference
• Access Context Manager Documentation
• github.com/googleapis/google-cloud-node/packages/google-identity-accesscontextmanager

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
  • Installing the client library
  • Using the client library
• Samples
• Versioning
• Contributing
• License

Quickstart

Before you begin

1. Select or create a Cloud Platform project.
2. Enable billing for your project.
3. Enable the Access Context Manager API.
4. 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/access-context-manager

Using the client library

/**
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. Resource name for the container to list AccessPolicy instances
 *  from.
 *  Format:
 *  `organizations/{org_id}`
 */
// const parent = 'abc123'
/**
 *  Number of AccessPolicy instances to include in the list. Default 100.
 */
// const pageSize = 1234
/**
 *  Next page token for the next batch of AccessPolicy instances. Defaults to
 *  the first page of results.
 */
// const pageToken = 'abc123'

// Imports the Accesscontextmanager library
const {AccessContextManagerClient} =
  require('@google-cloud/access-context-manager').v1;

// Instantiates a client
const accesscontextmanagerClient = new AccessContextManagerClient();

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

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

listAccessPolicies();

Samples

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

Sample	Source Code	Try it
Access_context_manager.commit_service_perimeters	source code
Access_context_manager.create_access_level	source code
Access_context_manager.create_access_policy	source code
Access_context_manager.create_gcp_user_access_binding	source code
Access_context_manager.create_service_perimeter	source code
Access_context_manager.delete_access_level	source code
Access_context_manager.delete_access_policy	source code
Access_context_manager.delete_gcp_user_access_binding	source code
Access_context_manager.delete_service_perimeter	source code
Access_context_manager.get_access_level	source code
Access_context_manager.get_access_policy	source code
Access_context_manager.get_gcp_user_access_binding	source code
Access_context_manager.get_iam_policy	source code
Access_context_manager.get_service_perimeter	source code
Access_context_manager.list_access_levels	source code
Access_context_manager.list_access_policies	source code
Access_context_manager.list_gcp_user_access_bindings	source code
Access_context_manager.list_service_perimeters	source code
Access_context_manager.replace_access_levels	source code
Access_context_manager.replace_service_perimeters	source code
Access_context_manager.set_iam_policy	source code
Access_context_manager.test_iam_permissions	source code
Access_context_manager.update_access_level	source code
Access_context_manager.update_access_policy	source code
Access_context_manager.update_gcp_user_access_binding	source code
Access_context_manager.update_service_perimeter	source code
Quickstart	source code

The Access Context Manager 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/access-context-manager@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