@maxim_mazurok/gapi.client.oslogin-v1 v0.0.20240504

TypeScript typings for Cloud OS Login API v1

You can use OS Login to manage access to your VM instances using IAM roles. For detailed description please check documentation.

Installing

Install typings for Cloud OS Login API:

npm install @types/gapi.client.oslogin-v1 --save-dev

Usage

You need to initialize Google API client in your code:

gapi.load('client', () => {
  // now we can use gapi.client
  // ...
});

Then load api client wrapper:

gapi.client.load(
  'https://oslogin.googleapis.com/$discovery/rest?version=v1',
  () => {
    // now we can use:
    // gapi.client.oslogin
  }
);

// Deprecated, use discovery document URL, see https://github.com/google/google-api-javascript-client/blob/master/docs/reference.md#----gapiclientloadname----version----callback--
gapi.client.load('oslogin', 'v1', () => {
  // now we can use:
  // gapi.client.oslogin
});

Don't forget to authenticate your client before sending any request to resources:

// declare client_id registered in Google Developers Console
var client_id = '',
  scope = [
    // See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
    'https://www.googleapis.com/auth/cloud-platform',

    // View your data across Google Cloud services and see the email address of your Google Account
    'https://www.googleapis.com/auth/cloud-platform.read-only',

    // View and manage your Google Compute Engine resources
    'https://www.googleapis.com/auth/compute',

    // View your Google Compute Engine resources
    'https://www.googleapis.com/auth/compute.readonly',
  ],
  immediate = true;
// ...

gapi.auth.authorize(
  {client_id: client_id, scope: scope, immediate: immediate},
  authResult => {
    if (authResult && !authResult.error) {
      /* handle successful authorization */
    } else {
      /* handle authorization error */
    }
  }
);

After that you can use Cloud OS Login API resources:

/*
Retrieves the profile information used for logging in to a virtual machine on Google Compute Engine.
*/
await gapi.client.oslogin.users.getLoginProfile({name: 'name'});

/*
Adds an SSH public key and returns the profile information. Default POSIX account information is set when no username and UID exist as part of the login profile.
*/
await gapi.client.oslogin.users.importSshPublicKey({parent: 'parent'});