package google.cloud.oslogin.v1alpha

Get desktop application:
View/edit binary Protocol Buffers messages

Cloud OS Login API The Cloud OS Login API allows you to manage users and their associated SSH public keys for logging into virtual machines on Google Cloud Platform.

• rpc DeletePosixAccount (DeletePosixAccountRequest, protobuf.Empty)

  oslogin.proto:37

  Deletes a POSIX account.

  message DeletePosixAccountRequest

  oslogin.proto:107

  A request message for deleting a POSIX account entry.

  • string name = 1

    A reference to the POSIX account to update. POSIX accounts are identified by the project ID they are associated with. A reference to the POSIX account is in format `users/{user}/projects/{project}`.

• rpc DeleteSshPublicKey (DeleteSshPublicKeyRequest, protobuf.Empty)

  oslogin.proto:45

  Deletes an SSH public key.

  message DeleteSshPublicKeyRequest

  oslogin.proto:115

  A request message for deleting an SSH public key.

  • string name = 1

    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}`.

• rpc GetLoginProfile (GetLoginProfileRequest, LoginProfile)

  oslogin.proto:54

  Retrieves the profile information used for logging in to a virtual machine on Google Compute Engine.

  message GetLoginProfileRequest

  oslogin.proto:123

  A request message for retrieving the login profile information for a user.

  • string name = 1

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

• rpc GetSshPublicKey (GetSshPublicKeyRequest, common.SshPublicKey)

  oslogin.proto:61

  Retrieves an SSH public key.

  message GetSshPublicKeyRequest

  oslogin.proto:129

  A request message for retrieving an SSH public key.

  • string name = 1

    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}`.

• rpc ImportSshPublicKey (ImportSshPublicKeyRequest, ImportSshPublicKeyResponse)

  oslogin.proto:71

  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.

  message ImportSshPublicKeyRequest

  oslogin.proto:137

  A request message for importing an SSH public key.

  • string parent = 1

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

  • optional common.SshPublicKey ssh_public_key = 2

    The SSH public key and expiration time.

  • string project_id = 3

    The project ID of the Google Cloud Platform project.

  message ImportSshPublicKeyResponse

  oslogin.proto:149

  A response message for importing an SSH public key.

  • optional LoginProfile login_profile = 1

    The login profile information for the user.

• rpc UpdateSshPublicKey (UpdateSshPublicKeyRequest, common.SshPublicKey)

  oslogin.proto:81

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

  message UpdateSshPublicKeyRequest

  oslogin.proto:155

  A request message for updating an SSH public key.

  • string name = 1

    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}`.

  • optional common.SshPublicKey ssh_public_key = 2

    The SSH public key and expiration time.

  • optional protobuf.FieldMask update_mask = 3

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

The user profile information used for logging in to a virtual machine on Google Compute Engine.

Used as response type in: OsLoginService.GetLoginProfile

Used as field type in: ImportSshPublicKeyResponse

• string name = 1

  A unique user ID for identifying the user.

• repeated common.PosixAccount posix_accounts = 2

  The list of POSIX accounts associated with the Directory API user.

• map<string, common.SshPublicKey> ssh_public_keys = 3

  A map from SSH public key fingerprint to the associated key object.

• bool suspended = 4

  Indicates if the user is suspended.