Cloud OS Login API

You can use OS Login to manage access to your VM instances using IAM roles. For more information, read OS Login.

Service: oslogin.googleapis.com

We recommend that you call this service using Google-provided client libraries. If your application needs to call this service using your own libraries, you should use the following information when making the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery documents:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service may have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://oslogin.googleapis.com

REST Resource: v1beta.users

Methods
getLoginProfile GET /v1beta/{name=users/*}/loginProfile
Retrieves the profile information used for logging in to a virtual machine on Google Compute Engine.
importSshPublicKey POST /v1beta/{parent=users/*}:importSshPublicKey
Adds an SSH public key and returns the profile information.

REST Resource: v1beta.users.projects

Methods
delete DELETE /v1beta/{name=users/*/projects/*}
Deletes a POSIX account.

REST Resource: v1beta.users.sshPublicKeys

Methods
delete DELETE /v1beta/{name=users/*/sshPublicKeys/*}
Deletes an SSH public key.
get GET /v1beta/{name=users/*/sshPublicKeys/*}
Retrieves an SSH public key.
patch PATCH /v1beta/{name=users/*/sshPublicKeys/*}
Updates an SSH public key and returns the profile information.

Service: oslogin.googleapis.com

We recommend that you call this service using Google-provided client libraries. If your application needs to call this service using your own libraries, you should use the following information when making the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery documents:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service may have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://oslogin.googleapis.com

REST Resource: v1alpha.users

Methods
getLoginProfile GET /v1alpha/{name=users/*}/loginProfile
Retrieves the profile information used for logging in to a virtual machine on Google Compute Engine.
importSshPublicKey POST /v1alpha/{parent=users/*}:importSshPublicKey
Adds an SSH public key and returns the profile information.

REST Resource: v1alpha.users.projects

Methods
delete DELETE /v1alpha/{name=users/*/projects/*}
Deletes a POSIX account.

REST Resource: v1alpha.users.sshPublicKeys

Methods
delete DELETE /v1alpha/{name=users/*/sshPublicKeys/*}
Deletes an SSH public key.
get GET /v1alpha/{name=users/*/sshPublicKeys/*}
Retrieves an SSH public key.
patch PATCH /v1alpha/{name=users/*/sshPublicKeys/*}
Updates an SSH public key and returns the profile information.

Service: oslogin.googleapis.com

We recommend that you call this service using Google-provided client libraries. If your application needs to call this service using your own libraries, you should use the following information when making the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery documents:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service may have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://oslogin.googleapis.com

REST Resource: v1.users

Methods
getLoginProfile GET /v1/{name=users/*}/loginProfile
Retrieves the profile information used for logging in to a virtual machine on Google Compute Engine.
importSshPublicKey POST /v1/{parent=users/*}:importSshPublicKey
Adds an SSH public key and returns the profile information.

REST Resource: v1.users.projects

Methods
delete DELETE /v1/{name=users/*/projects/*}
Deletes a POSIX account.

REST Resource: v1.users.sshPublicKeys

Methods
delete DELETE /v1/{name=users/*/sshPublicKeys/*}
Deletes an SSH public key.
get GET /v1/{name=users/*/sshPublicKeys/*}
Retrieves an SSH public key.
patch PATCH /v1/{name=users/*/sshPublicKeys/*}
Updates an SSH public key and returns the profile information.
Was this page helpful? Let us know how we did:

Send feedback about...

Compute Engine