Identity and Access Management (IAM) API: Nodejs Client

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

Identity and Access Management (IAM) API client for Node.js

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

• Identity and Access Management (IAM) API Nodejs Client API Reference

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

• Versioning

• Contributing

• License

Quickstart

Before you begin

1. Select or create a Cloud Platform project.
2. Enable billing for your project.
3. Enable the Identity and Access Management (IAM) API API.
4. Set up authentication so you can access the API from your local workstation.

Installing the client library

npm install iam

Samples

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

| Sample | Source Code | | --------------------------- | --------------------------------- | | iam | source code | | create workload identity pool | source code | | create workload identity pool provider | source code | | delete workload identity pool | source code | | delete workload identity pool provider | source code | | get workload identity pool | source code | | get workload identity pool provider | source code | | list workload identity pool providers | source code | | list workload identity pools | source code | | undelete workload identity pool | source code | | undelete workload identity pool provider | source code | | update workload identity pool | source code | | update workload identity pool provider | source code | | create policy | source code | | delete policy | source code | | get policy | source code | | list policies | source code | | update policy | source code | | iam | source code | | create policy | source code | | delete policy | source code | | get policy | source code | | list policies | source code | | update policy | source code | | iam | source code | | create policy binding | source code | | delete policy binding | source code | | get policy binding | source code | | list policy bindings | source code | | search target policy bindings | source code | | update policy binding | source code | | create principal access boundary policy | source code | | delete principal access boundary policy | source code | | get principal access boundary policy | source code | | list principal access boundary policies | source code | | search principal access boundary policy bindings | source code | | update principal access boundary policy | source code | | iam | source code | | create policy binding | source code | | delete policy binding | source code | | get policy binding | source code | | list policy bindings | source code | | search target policy bindings | source code | | update policy binding | source code | | create principal access boundary policy | source code | | delete principal access boundary policy | source code | | get principal access boundary policy | source code | | list principal access boundary policies | source code | | search principal access boundary policy bindings | source code | | update principal access boundary policy | source code | | iam | source code |

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 iam@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

Please note that this README.md and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template.

License

Apache Version 2.0

See LICENSE