Identity-Aware Proxy: Node.js Client

release level npm version

iap 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 Identity-Aware Proxy 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/iap

Using the client library

// Imports the Google Cloud client library

// remove this line after package is released
// eslint-disable-next-line node/no-missing-require
const {IdentityAwareProxyOAuthServiceClient} = require('@google-cloud/iap');

// const projectId = 'my-project'

// Creates a client
const client = new IdentityAwareProxyOAuthServiceClient();

async function listBrands() {
  const [brands] = await client.listBrands({
    parent: `projects/${projectId}`,


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

SampleSource CodeTry it
Identity_aware_proxy_admin_service.create_tunnel_dest_groupsource codeOpen in Cloud Shell
Identity_aware_proxy_admin_service.delete_tunnel_dest_groupsource codeOpen in Cloud Shell
Identity_aware_proxy_admin_service.get_iam_policysource codeOpen in Cloud Shell
Identity_aware_proxy_admin_service.get_iap_settingssource codeOpen in Cloud Shell
Identity_aware_proxy_admin_service.get_tunnel_dest_groupsource codeOpen in Cloud Shell
Identity_aware_proxy_admin_service.list_tunnel_dest_groupssource codeOpen in Cloud Shell
Identity_aware_proxy_admin_service.set_iam_policysource codeOpen in Cloud Shell
Identity_aware_proxy_admin_service.test_iam_permissionssource codeOpen in Cloud Shell
Identity_aware_proxy_admin_service.update_iap_settingssource codeOpen in Cloud Shell
Identity_aware_proxy_admin_service.update_tunnel_dest_groupsource codeOpen in Cloud Shell
Identity_aware_proxy_o_auth_service.create_brandsource codeOpen in Cloud Shell
Identity_aware_proxy_o_auth_service.create_identity_aware_proxy_clientsource codeOpen in Cloud Shell
Identity_aware_proxy_o_auth_service.delete_identity_aware_proxy_clientsource codeOpen in Cloud Shell
Identity_aware_proxy_o_auth_service.get_brandsource codeOpen in Cloud Shell
Identity_aware_proxy_o_auth_service.get_identity_aware_proxy_clientsource codeOpen in Cloud Shell
Identity_aware_proxy_o_auth_service.list_brandssource codeOpen in Cloud Shell
Identity_aware_proxy_o_auth_service.list_identity_aware_proxy_clientssource codeOpen in Cloud Shell
Identity_aware_proxy_o_auth_service.reset_identity_aware_proxy_client_secretsource codeOpen in Cloud Shell
Identity_aware_proxy_admin_v1_beta1.get_iam_policysource codeOpen in Cloud Shell
Identity_aware_proxy_admin_v1_beta1.set_iam_policysource codeOpen in Cloud Shell
Identity_aware_proxy_admin_v1_beta1.test_iam_permissionssource codeOpen in Cloud Shell
Quickstartsource codeOpen in Cloud Shell
Quickstartsource codeOpen in Cloud Shell

The Identity-Aware Proxy 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/iap@legacy-8 installs client libraries for versions compatible with Node.js 8.


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


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