Home - Documentation

Google Cloud OS Login API client for Node.js

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.

Table of contents:

Quickstart
Samples
Versioning
Contributing
License

Quickstart

Before you begin

Select or create a Cloud Platform project.
Enable billing for your project.
Enable the Google Cloud OS Login API.
Set up authentication with a service account so you can access the API from your local workstation.

Installing the client library

npm install @google-cloud/os-login

Using the client library

  const {OsLoginServiceClient} = require('@google-cloud/os-login');
  const client = new OsLoginServiceClient();

  async function quickstart() {
    const [loginProfile] = await client.getLoginProfile({
      name: 'users/beckwith@google.com',
    });
    console.log('Login Profile:');
    console.log(loginProfile);
  }

  quickstart();

Samples

Samples are in the samples/ directory. The samples' README.md has instructions for running the samples.

Sample	Source Code	Try it
Quickstart	source code

The Google Cloud OS Login Node.js Client API Reference documentation also contains samples.

Versioning

This library follows Semantic Versioning.

This library is considered to be in alpha. 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.

License

Apache Version 2.0

See LICENSE

Google Cloud OS Login: Node.js Client