Identity-Aware Proxy: Node.js Client

release levelnpm version

iap client for Node.js

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

Read more about the client libraries for Cloud APIs, including the olderGoogle APIs Client Libraries, inClient Libraries Explained.

Table of contents:

Quickstart

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 so you can access theAPI 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-requireconst {IdentityAwareProxyOAuthServiceClient} = require('@google-cloud/iap');// const projectId = 'my-project'// Creates a clientconst client = newIdentityAwareProxyOAuthServiceClient();async function listBrands() {  const [brands] = await client.listBrands({    parent: `projects/${projectId}`,  });  console.info(brands);}listBrands();

Samples

Samples are in thesamples/ directory. Each sample'sREADME.md 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_admin_service.validate_iap_attribute_expressionsource 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

TheIdentity-Aware Proxy Node.js Client API Reference documentationalso contains samples.

Supported Node.js Versions

Our client libraries follow theNode.js release schedule.Libraries are compatible with all currentactive andmaintenance versions ofNode.js.If you are using an end-of-life version of Node.js, we recommend that you updateas soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on abest-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, andcan be installed through npmdist-tags.The dist-tags follow the naming conventionlegacy-(version).For example,npm install @google-cloud/iap@legacy-8 installs client librariesfor versions compatible with Node.js 8.

Versioning

This library followsSemantic Versioning.

This library is considered to bestable. The code surface will not change in backwards-incompatible waysunless absolutely necessary (e.g. because of critical security issues) or withan extensive deprecation period. Issues and requests againststable librariesare addressed with the highest priority.

More Information:Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See theContributing Guide.

Please note that thisREADME.md, thesamples/README.md,and a variety of configuration files in this repository (including.nycrc andtsconfig.json)are generated from a central template. To edit one of these files, make an editto its templates indirectory.

License

Apache Version 2.0

SeeLICENSE

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-10-30 UTC.