Google Cloud Platform logo

Google Cloud OS Login: Node.js Client

release level npm version codecov

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:


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 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/',
    console.log('Login Profile:');



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

Sample Source Code Try it
Quickstart source code Open in Cloud Shell

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


This library follows Semantic Versioning.

This library is considered to be in beta. This means it is expected to be mostly stable while we work toward a general availability release; however, complete stability is not guaranteed. We will address issues and requests against beta libraries with a high priority.

More Information: Google Cloud Platform Launch Stages


Contributions welcome! See the Contributing Guide.


Apache Version 2.0