Identity-Aware Proxy: Node.js Client
iap client for Node.js
A comprehensive list of changes in each version may be found in the CHANGELOG .
- Identity-Aware Proxy Node.js Client API Reference
- Identity-Aware Proxy Documentation
- github.com/googleapis/google-cloud-node/packages/google-cloud-iap
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
- Select or create a Cloud Platform project .
- Enable billing for your project .
- Enable the Identity-Aware Proxy API .
- Set up authentication 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}`,
});
console.info(brands);
}
listBrands();
Samples
Samples are in the samples/
directory. Each sample's README.md
has instructions for running its sample.
Sample | Source Code | Try it |
---|---|---|
Identity_aware_proxy_admin_service.create_tunnel_dest_group
|
source code | ![]() |
Identity_aware_proxy_admin_service.delete_tunnel_dest_group
|
source code | ![]() |
Identity_aware_proxy_admin_service.get_iam_policy
|
source code | ![]() |
Identity_aware_proxy_admin_service.get_iap_settings
|
source code | ![]() |
Identity_aware_proxy_admin_service.get_tunnel_dest_group
|
source code | ![]() |
Identity_aware_proxy_admin_service.list_tunnel_dest_groups
|
source code | ![]() |
Identity_aware_proxy_admin_service.set_iam_policy
|
source code | ![]() |
Identity_aware_proxy_admin_service.test_iam_permissions
|
source code | ![]() |
Identity_aware_proxy_admin_service.update_iap_settings
|
source code | ![]() |
Identity_aware_proxy_admin_service.update_tunnel_dest_group
|
source code | ![]() |
Identity_aware_proxy_admin_service.validate_iap_attribute_expression
|
source code | ![]() |
Identity_aware_proxy_o_auth_service.create_brand
|
source code | ![]() |
Identity_aware_proxy_o_auth_service.create_identity_aware_proxy_client
|
source code | ![]() |
Identity_aware_proxy_o_auth_service.delete_identity_aware_proxy_client
|
source code | ![]() |
Identity_aware_proxy_o_auth_service.get_brand
|
source code | ![]() |
Identity_aware_proxy_o_auth_service.get_identity_aware_proxy_client
|
source code | ![]() |
Identity_aware_proxy_o_auth_service.list_brands
|
source code | ![]() |
Identity_aware_proxy_o_auth_service.list_identity_aware_proxy_clients
|
source code | ![]() |
Identity_aware_proxy_o_auth_service.reset_identity_aware_proxy_client_secret
|
source code | ![]() |
Identity_aware_proxy_admin_v1_beta1.get_iam_policy
|
source code | ![]() |
Identity_aware_proxy_admin_v1_beta1.set_iam_policy
|
source code | ![]() |
Identity_aware_proxy_admin_v1_beta1.test_iam_permissions
|
source code | ![]() |
Quickstart
|
source code | ![]() |
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.
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 stablelibraries 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