Method: users.importSshPublicKey

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.

HTTP request

POST https://oslogin.googleapis.com/v1alpha/{parent=users/*}:importSshPublicKey

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

The unique ID for the user in format users/{user}.

Query parameters

Parameters
projectId

string

The project ID of the Google Cloud Platform project.
view

enum (LoginProfileView)

The view configures whether to retrieve security keys information.
regions[]

string

Optional. The regions to which to assert that the key was written. If unspecified, defaults to all regions. Regions are listed at https://cloud.google.com/about/locations#region.

Request body

The request body contains an instance of SshPublicKey.

Response body

A response message for importing an SSH public key.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "loginProfile": {
    object (LoginProfile)
  },
  "details": string
}
Fields
loginProfile

object (LoginProfile)

The login profile information for the user.
details

string

Detailed information about import results.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/compute

For more information, see the Authentication Overview.