Abstract types

DeletePosixAccountRequest

static

A request message for deleting a POSIX account entry.

Property

Parameter

name

string

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

See also

google.cloud.oslogin.v1beta.DeletePosixAccountRequest definition in proto format

DeleteSshPublicKeyRequest

static

A request message for deleting an SSH public key.

Property

Parameter

name

string

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

See also

google.cloud.oslogin.v1beta.DeleteSshPublicKeyRequest definition in proto format

GetLoginProfileRequest

static

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

Property

Parameter

name

string

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

See also

google.cloud.oslogin.v1beta.GetLoginProfileRequest definition in proto format

GetSshPublicKeyRequest

static

A request message for retrieving an SSH public key.

Property

Parameter

name

string

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

See also

google.cloud.oslogin.v1beta.GetSshPublicKeyRequest definition in proto format

ImportSshPublicKeyRequest

static

A request message for importing an SSH public key.

Properties

Parameter

parent

string

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

sshPublicKey

Object

The SSH public key and expiration time.

This object should have the same structure as SshPublicKey

projectId

string

The project ID of the Google Cloud Platform project.

See also

google.cloud.oslogin.v1beta.ImportSshPublicKeyRequest definition in proto format

ImportSshPublicKeyResponse

static

A response message for importing an SSH public key.

Property

Parameter

loginProfile

Object

The login profile information for the user.

This object should have the same structure as LoginProfile

See also

google.cloud.oslogin.v1beta.ImportSshPublicKeyResponse definition in proto format

LoginProfile

static

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

Properties

Parameter

name

string

The primary email address that uniquely identifies the user.

posixAccounts

Array of Object

The list of POSIX accounts associated with the user.

This object should have the same structure as PosixAccount

sshPublicKeys

Object with Object properties

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

suspended

boolean

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

See also

google.cloud.oslogin.v1beta.LoginProfile definition in proto format

UpdateSshPublicKeyRequest

static

A request message for updating an SSH public key.

Properties

Parameter

name

string

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

Object

The SSH public key and expiration time.

This object should have the same structure as SshPublicKey

updateMask

Object

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

This object should have the same structure as FieldMask

See also

google.cloud.oslogin.v1beta.UpdateSshPublicKeyRequest definition in proto format