Google Cloud OS Login: Node.js Client

Google Cloud OS Login API client for Node.js

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

• Google Cloud OS Login Node.js Client API Reference
• Google Cloud OS Login Documentation
• github.com/googleapis/google-cloud-node/packages/google-cloud-oslogin

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
  • Installing the client library
  • Using the client library
• Samples
• Versioning
• Contributing
• License

Quickstart

Before you begin

1. Select or create a Cloud Platform project.
2. Enable billing for your project.
3. Enable the Google Cloud OS Login API.
4. Set up authentication so you can access theAPI from your local workstation.

Installing the client library

npm install @google-cloud/os-login

Using the client library

/** * TODO(developer): Uncomment these variables before running the sample. *//** *  Required. The unique ID for the user in format `users/{user}`. */// const name = 'abc123'/** *  The project ID of the Google Cloud Platform project. */// const projectId = 'abc123'/** *  A system ID for filtering the results of the request. */// const systemId = 'abc123'// Imports the Oslogin libraryconst {OsLoginServiceClient} = require('@google-cloud/os-login').v1;// Instantiates a clientconst osloginClient = newOsLoginServiceClient();async function callGetLoginProfile() {  // Construct request  const request = {    name,  };  // Run request  const response = await osloginClient.getLoginProfile(request);  console.log(response[0]);}callGetLoginProfile();

Samples

Samples are in thesamples/ directory. Each sample'sREADME.md has instructions for running its sample.

Sample	Source Code	Try it
Os_login_service.create_ssh_public_key	source code
Os_login_service.delete_posix_account	source code
Os_login_service.delete_ssh_public_key	source code
Os_login_service.get_login_profile	source code
Os_login_service.get_ssh_public_key	source code
Os_login_service.import_ssh_public_key	source code
Os_login_service.update_ssh_public_key	source code
Os_login_service.create_ssh_public_key	source code
Os_login_service.delete_posix_account	source code
Os_login_service.delete_ssh_public_key	source code
Os_login_service.get_login_profile	source code
Os_login_service.get_ssh_public_key	source code
Os_login_service.import_ssh_public_key	source code
Os_login_service.sign_ssh_public_key	source code
Os_login_service.update_ssh_public_key	source code
Quickstart	source code

TheGoogle Cloud OS Login 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/os-login@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