Privileged Access Manager API: Node.js Client
Privileged Access Manager API client for Node.js
A comprehensive list of changes in each version may be found in the CHANGELOG .
- Privileged Access Manager API Node.js Client API Reference
- Privileged Access Manager API Documentation
- github.com/googleapis/google-cloud-node/packages/google-cloud-privilegedaccessmanager
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 Privileged Access Manager API API .
- Set up authentication so you can access the API from your local workstation.
Installing the client library
npm install @google-cloud/privilegedaccessmanager
Using the client library
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent which owns the entitlement resources.
*/
// const parent = 'projects/${projectId}/locations/global'
/**
* Optional. Requested page size. Server may return fewer items than
* requested. If unspecified, the server picks 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 Privilegedaccessmanager library
const {PrivilegedAccessManagerClient} =
require(' @google-cloud/privilegedaccessmanager
').v1;
// Instantiates a client
const privilegedaccessmanagerClient = new PrivilegedAccessManagerClient
();
async function callListEntitlements() {
// Construct request
const request = {
parent,
};
// Run request
const iterable =
privilegedaccessmanagerClient. listEntitlementsAsync
(request);
for await (const response of iterable) {
console.log(response);
}
}
callListEntitlements();
Samples
Samples are in the samples/
directory. Each sample's README.md
has instructions for running its sample.
Sample | Source Code | Try it |
---|---|---|
Privileged_access_manager.approve_grant
|
source code | ![]() |
Privileged_access_manager.check_onboarding_status
|
source code | ![]() |
Privileged_access_manager.create_entitlement
|
source code | ![]() |
Privileged_access_manager.create_grant
|
source code | ![]() |
Privileged_access_manager.delete_entitlement
|
source code | ![]() |
Privileged_access_manager.deny_grant
|
source code | ![]() |
Privileged_access_manager.get_entitlement
|
source code | ![]() |
Privileged_access_manager.get_grant
|
source code | ![]() |
Privileged_access_manager.list_entitlements
|
source code | ![]() |
Privileged_access_manager.list_grants
|
source code | ![]() |
Privileged_access_manager.revoke_grant
|
source code | ![]() |
Privileged_access_manager.search_entitlements
|
source code | ![]() |
Privileged_access_manager.search_grants
|
source code | ![]() |
Privileged_access_manager.update_entitlement
|
source code | ![]() |
Quickstart
|
source code | ![]() |
The Privileged Access Manager 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/privilegedaccessmanager@legacy-8
installs client libraries
for versions compatible with Node.js 8.
Versioning
This library follows Semantic Versioning .
This library is considered to be in preview. This means it is still a work-in-progress and under active development. Any release is subject to backwards-incompatible changes at any time.
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