Types for Google Cloud OS Login API Client#

class google.cloud.oslogin_v1.types.DeletePosixAccountRequest#

A request message for deleting a POSIX account entry.

name#

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

name

Field google.cloud.oslogin.v1.DeletePosixAccountRequest.name

class google.cloud.oslogin_v1.types.DeleteSshPublicKeyRequest#

A request message for deleting an SSH public key.

name#

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

name

Field google.cloud.oslogin.v1.DeleteSshPublicKeyRequest.name

class google.cloud.oslogin_v1.types.Empty#
class google.cloud.oslogin_v1.types.FieldMask#
paths#

Field google.protobuf.FieldMask.paths

class google.cloud.oslogin_v1.types.GetLoginProfileRequest#

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

name#

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

name

Field google.cloud.oslogin.v1.GetLoginProfileRequest.name

class google.cloud.oslogin_v1.types.GetSshPublicKeyRequest#

A request message for retrieving an SSH public key.

name#

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

name

Field google.cloud.oslogin.v1.GetSshPublicKeyRequest.name

class google.cloud.oslogin_v1.types.ImportSshPublicKeyRequest#

A request message for importing an SSH public key.

parent#

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

ssh_public_key#

The SSH public key and expiration time.

project_id#

The project ID of the Google Cloud Platform project.

parent

Field google.cloud.oslogin.v1.ImportSshPublicKeyRequest.parent

project_id

Field google.cloud.oslogin.v1.ImportSshPublicKeyRequest.project_id

ssh_public_key

Field google.cloud.oslogin.v1.ImportSshPublicKeyRequest.ssh_public_key

class google.cloud.oslogin_v1.types.ImportSshPublicKeyResponse#

A response message for importing an SSH public key.

login_profile#

The login profile information for the user.

login_profile

Field google.cloud.oslogin.v1.ImportSshPublicKeyResponse.login_profile

class google.cloud.oslogin_v1.types.LoginProfile#

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

name#

The primary email address that uniquely identifies the user.

posix_accounts#

The list of POSIX accounts associated with the user.

ssh_public_keys#

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

suspended#

Indicates if the user is suspended. A suspended user cannot log in but their profile information is retained.

class SshPublicKeysEntry#
key#

Field google.cloud.oslogin.v1.LoginProfile.SshPublicKeysEntry.key

value#

Field google.cloud.oslogin.v1.LoginProfile.SshPublicKeysEntry.value

name

Field google.cloud.oslogin.v1.LoginProfile.name

posix_accounts

Field google.cloud.oslogin.v1.LoginProfile.posix_accounts

ssh_public_keys

Field google.cloud.oslogin.v1.LoginProfile.ssh_public_keys

suspended

Field google.cloud.oslogin.v1.LoginProfile.suspended

class google.cloud.oslogin_v1.types.PosixAccount#

The POSIX account information associated with a Google account.

primary#

Only one POSIX account can be marked as primary.

username#

The username of the POSIX account.

uid#

The user ID.

gid#

The default group ID.

home_directory#

The path to the home directory for this account.

shell#

The path to the logic shell for this account.

gecos#

The GECOS (user information) entry for this account.

system_id#

System identifier for which account the username or uid applies to. By default, the empty value is used.

account_id#

Output only. A POSIX account identifier.

account_id

Field google.cloud.oslogin.common.PosixAccount.account_id

gecos

Field google.cloud.oslogin.common.PosixAccount.gecos

gid

Field google.cloud.oslogin.common.PosixAccount.gid

home_directory

Field google.cloud.oslogin.common.PosixAccount.home_directory

primary

Field google.cloud.oslogin.common.PosixAccount.primary

shell

Field google.cloud.oslogin.common.PosixAccount.shell

system_id

Field google.cloud.oslogin.common.PosixAccount.system_id

uid

Field google.cloud.oslogin.common.PosixAccount.uid

username

Field google.cloud.oslogin.common.PosixAccount.username

class google.cloud.oslogin_v1.types.SshPublicKey#

The SSH public key information associated with a Google account.

key#

Public key text in SSH format, defined by RFC4253 section 6.6.

expiration_time_usec#

An expiration time in microseconds since epoch.

fingerprint#

Output only. The SHA-256 fingerprint of the SSH public key.

expiration_time_usec

Field google.cloud.oslogin.common.SshPublicKey.expiration_time_usec

fingerprint

Field google.cloud.oslogin.common.SshPublicKey.fingerprint

key

Field google.cloud.oslogin.common.SshPublicKey.key

class google.cloud.oslogin_v1.types.UpdateSshPublicKeyRequest#

A request message for updating an SSH public key.

name#

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

ssh_public_key#

The SSH public key and expiration time.

update_mask#

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

name

Field google.cloud.oslogin.v1.UpdateSshPublicKeyRequest.name

ssh_public_key

Field google.cloud.oslogin.v1.UpdateSshPublicKeyRequest.ssh_public_key

update_mask

Field google.cloud.oslogin.v1.UpdateSshPublicKeyRequest.update_mask