class UsersSshPublicKeys extends Resource (View source)

The "sshPublicKeys" collection of methods.

Typical usage is:

 $osloginService = new Google\Service\CloudOSLogin(...);
 $sshPublicKeys = $osloginService->users_sshPublicKeys;

Methods

create(string $parent, SshPublicKey $postBody, array $optParams = [])

Create an SSH public key (sshPublicKeys.create)

delete(string $name, array $optParams = [])

Deletes an SSH public key. (sshPublicKeys.delete)

get(string $name, array $optParams = [])

Retrieves an SSH public key. (sshPublicKeys.get)

patch(string $name, SshPublicKey $postBody, array $optParams = [])

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

Details

SshPublicKey create(string $parent, SshPublicKey $postBody, array $optParams = [])

Create an SSH public key (sshPublicKeys.create)

Parameters

string $parent

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

SshPublicKey $postBody
array $optParams

Optional parameters.

Return Value

SshPublicKey

Exceptions

Exception

OsloginEmpty delete(string $name, array $optParams = [])

Deletes an SSH public key. (sshPublicKeys.delete)

Parameters

string $name

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 format users/{user}/sshPublicKeys/{fingerprint}.

array $optParams

Optional parameters.

Return Value

OsloginEmpty

Exceptions

Exception

SshPublicKey get(string $name, array $optParams = [])

Retrieves an SSH public key. (sshPublicKeys.get)

Parameters

string $name

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

array $optParams

Optional parameters.

Return Value

SshPublicKey

Exceptions

Exception

SshPublicKey patch(string $name, SshPublicKey $postBody, array $optParams = [])

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

Parameters

string $name

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 format users/{user}/sshPublicKeys/{fingerprint}.

SshPublicKey $postBody
array $optParams

Optional parameters.

Return Value

SshPublicKey

Exceptions

Exception