Stay organized with collections Save and categorize content based on your preferences.

BeyondCorp API: Node.js Client

release level npm version

BeyondCorp API client for Node.js

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:


Before you begin

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Enable the BeyondCorp API 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/clientgateways

Using the client library

 * TODO(developer): Uncomment these variables before running the sample.
 *  Required. Parent value for ListClientGatewaysRequest.
// const parent = 'abc123'
 *  Optional. Requested page size. Server may return fewer items than
 *  requested. If unspecified, server will pick an appropriate default.
// const pageSize = 1234
 *  Optional. A token identifying a page of results the server should return.
// const pageToken = 'abc123'
 *  Optional. Filtering results.
// const filter = 'abc123'
 *  Optional. Hint for how to order the results.
// const orderBy = 'abc123'

// Imports the Clientgateways library
const {ClientGatewaysServiceClient} =

// Instantiates a client
const clientgatewaysClient = new ClientGatewaysServiceClient();

async function callListClientGateways() {
  // Construct request
  const request = {

  // Run request
  const iterable = await clientgatewaysClient.listClientGatewaysAsync(
  for await (const response of iterable) {



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

SampleSource CodeTry it
Client_gateways_service.create_client_gatewaysource codeOpen in Cloud Shell
Client_gateways_service.delete_client_gatewaysource codeOpen in Cloud Shell
Client_gateways_service.get_client_gatewaysource codeOpen in Cloud Shell
Client_gateways_service.list_client_gatewayssource codeOpen in Cloud Shell
Quickstartsource codeOpen in Cloud Shell
Quickstartsource codeOpen in Cloud Shell

The BeyondCorp API 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/clientgateways@legacy-8 installs client libraries for versions compatible with Node.js 8.


This library follows Semantic Versioning.

This library is considered to be in beta. This means it is expected to be mostly stable while we work toward a general availability release; however, complete stability is not guaranteed. We will address issues and requests against beta libraries with a high priority.

More Information: Google Cloud Platform Launch Stages


Contributions welcome! See the Contributing Guide.

Please note that this, the samples/, 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.


Apache Version 2.0