Method: users.sshPublicKeys.patch

Updates an SSH public key and returns the profile information. This method supports patch semantics.

HTTP request

PATCH https://oslogin.googleapis.com/v1/{name=users/*/sshPublicKeys/*}

The URL usesgRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The fingerprint of the public key to update. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in formatusers/{user}/sshPublicKeys/{fingerprint}.

Query parameters

Parameters
updateMask

string (FieldMask format)

Optional. Mask to control which fields get updated. Updates all if not present.

This is a comma-separated list of fully qualified names of fields. Example:"user.displayName,photo".

Request body

The request body contains an instance ofSshPublicKey.

Response body

If successful, the response body contains an instance ofSshPublicKey.

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 theAuthentication Overview.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-07-28 UTC.