As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Types for Google Cloud Oslogin v1 API

class google.cloud.oslogin_v1.types.CreateSshPublicKeyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for creating an SSH public key.

parent

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

Type

str

ssh_public_key

Required. The SSH public key and expiration time.

Type

google.cloud.oslogin_v1.common.types.SshPublicKey

class google.cloud.oslogin_v1.types.DeletePosixAccountRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for deleting a POSIX account entry.

name

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

Type

str

class google.cloud.oslogin_v1.types.DeleteSshPublicKeyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for deleting an SSH public key.

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

Type

str

class google.cloud.oslogin_v1.types.GetLoginProfileRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

name

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

Type

str

project_id

The project ID of the Google Cloud Platform project.

Type

str

system_id

A system ID for filtering the results of the request.

Type

str

class google.cloud.oslogin_v1.types.GetSshPublicKeyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for retrieving an SSH public key.

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

Type

str

class google.cloud.oslogin_v1.types.ImportSshPublicKeyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for importing an SSH public key.

parent

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

Type

str

ssh_public_key

Optional. The SSH public key and expiration time.

Type

google.cloud.oslogin_v1.common.types.SshPublicKey

project_id

The project ID of the Google Cloud Platform project.

Type

str

regions

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.

Type

MutableSequence[str]

class google.cloud.oslogin_v1.types.ImportSshPublicKeyResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A response message for importing an SSH public key.

login_profile

The login profile information for the user.

Type

google.cloud.oslogin_v1.types.LoginProfile

details

Detailed information about import results.

Type

str

class google.cloud.oslogin_v1.types.LoginProfile(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

name

Required. A unique user ID.

Type

str

posix_accounts

The list of POSIX accounts associated with the user.

Type

MutableSequence[google.cloud.oslogin_v1.common.types.PosixAccount]

ssh_public_keys

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

Type

MutableMapping[str, google.cloud.oslogin_v1.common.types.SshPublicKey]

class SshPublicKeysEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.oslogin_v1.types.UpdateSshPublicKeyRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request message for updating an SSH public key.

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

Type

str

ssh_public_key

Required. The SSH public key and expiration time.

Type

google.cloud.oslogin_v1.common.types.SshPublicKey

update_mask

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

Type

google.protobuf.field_mask_pb2.FieldMask