package google.cloud.oslogin.v1beta
Get desktop application:
View/edit binary Protocol Buffers messages
service OsLoginService
oslogin.proto:39Cloud 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 CreateSshPublicKey (, )
oslogin.proto:48Create an SSH public key
message
oslogin.proto:150A request message for creating an SSH public key.
string parent = 1
Required. The unique ID for the user in format `users/{user}`.
optional ssh_public_key = 2
Required. The SSH public key and expiration time.
rpc DeletePosixAccount (, )
oslogin.proto:58Deletes a POSIX account.
message
oslogin.proto:165A request message for deleting a POSIX account entry.
string name = 1
Required. 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 (, )
oslogin.proto:67Deletes an SSH public key.
message
oslogin.proto:178A request message for deleting an SSH public key.
string name = 1
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}`.
rpc GetLoginProfile (, )
oslogin.proto:77Retrieves the profile information used for logging in to a virtual machine on Google Compute Engine.
message
oslogin.proto:191A request message for retrieving the login profile information for a user.
string name = 1
Required. The unique ID for the user in format `users/{user}`.
string project_id = 2
The project ID of the Google Cloud Platform project.
string system_id = 3
A system ID for filtering the results of the request.
LoginProfileView view = 4
The view configures whether to retrieve security keys information.
rpc GetSshPublicKey (, )
oslogin.proto:85Retrieves an SSH public key.
message
oslogin.proto:209A request message for retrieving an SSH public key.
string name = 1
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}`.
rpc ImportSshPublicKey (, )
oslogin.proto:96Adds 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
oslogin.proto:222A request message for importing an SSH public key.
string parent = 1
The unique ID for the user in format `users/{user}`.
optional ssh_public_key = 2
Required. The SSH public key and expiration time.
string project_id = 3
The project ID of the Google Cloud Platform project.
LoginProfileView view = 4
The view configures whether to retrieve security keys information.
repeated string regions = 5
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.
message
oslogin.proto:245A response message for importing an SSH public key.
optional login_profile = 1
The login profile information for the user.
string details = 2
Detailed information about import results.
rpc SignSshPublicKey (, )
oslogin.proto:119Signs an SSH public key for a user to authenticate to an instance.
message
oslogin.proto:307string ssh_public_key = 1
The SSH public key to sign.
string parent = 2
The parent project and region for the signing request.
message
oslogin.proto:315string signed_ssh_public_key = 1
The signed SSH public key to use in the SSH handshake.
rpc UpdateSshPublicKey (, )
oslogin.proto:108Updates an SSH public key and returns the profile information. This method supports patch semantics.
message
oslogin.proto:254A request message for updating an SSH public key.
string name = 1
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}`.
optional ssh_public_key = 2
Required. The SSH public key and expiration time.
optional update_mask = 3
Mask to control which fields get updated. Updates all if not present.
message
oslogin.proto:135The 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:
string name = 1
Required. A unique user ID.
repeated posix_accounts = 2
The list of POSIX accounts associated with the user.
map<string, > ssh_public_keys = 3
A map from SSH public key fingerprint to the associated key object.
repeated security_keys = 5
The registered security key credentials for a user.
The login profile view limits the user content retrieved.
Used in: ,
LOGIN_PROFILE_VIEW_UNSPECIFIED = 0
The default login profile view. The API defaults to the BASIC view.
BASIC = 1
Includes POSIX and SSH key information.
SECURITY_KEY = 2
Include security key information for the user.
message
oslogin.proto:274The credential information for a Google registered security key.
Used in:
string public_key = 1
Public key text in SSH format, defined by [RFC4253]("https://www.ietf.org/rfc/rfc4253.txt") section 6.6.
string private_key = 2
Hardware-backed private key text in SSH format.
oneof protocol_type
The FIDO protocol type used to register this credential.
universal_two_factor = 3
The U2F protocol type.
web_authn = 4
The Web Authentication protocol type.
optional string device_nickname = 5
The security key nickname explicitly set by the user.
message
oslogin.proto:296Security key information specific to the U2F protocol.
Used in:
string app_id = 1
Application ID for the U2F protocol.
message
oslogin.proto:302Security key information specific to the Web Authentication protocol.
Used in:
string rp_id = 1
Relying party ID for Web Authentication.