Class OsLoginServiceClient (2.0.0)

OsLoginServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.oslogin_v1.services.os_login_service.transports.base.OsLoginServiceTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

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.

Methods

OsLoginServiceClient

OsLoginServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.oslogin_v1.services.os_login_service.transports.base.OsLoginServiceTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiate the os login service client.

Parameters
Name	Description
`credentials`	`Optional[google.auth.credentials.Credentials]` The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
`transport`	`Union[str, .OsLoginServiceTransport]` The transport to use. If set to None, a transport is chosen automatically.
`client_options`	`client_options_lib.ClientOptions` Custom options for the client. It won't take effect if a `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the `api_endpoint` property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.
`client_info`	`google.api_core.gapic_v1.client_info.ClientInfo` The client info used to send a user-agent string along with API requests. If `None`, then default info will be used. Generally, you only need to set this if you're developing your own client library.

Exceptions
Type	Description
`google.auth.exceptions.MutualTLSChannelError`	If mutual TLS transport creation failed for any reason.

delete_posix_account

delete_posix_account(request: Optional[google.cloud.oslogin_v1.types.oslogin.DeletePosixAccountRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a POSIX account.

Parameters
Name	Description
`request`	`.oslogin.DeletePosixAccountRequest` The request object. A request message for deleting a POSIX account entry.
`name`	`str` 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}`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

delete_ssh_public_key

delete_ssh_public_key(request: Optional[google.cloud.oslogin_v1.types.oslogin.DeleteSshPublicKeyRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes an SSH public key.

Parameters
Name	Description
`request`	`.oslogin.DeleteSshPublicKeyRequest` The request object. A request message for deleting an SSH public key.
`name`	`str` 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}`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`{@api.name}`	The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`{@api.name}`	The constructed client.

get_login_profile

get_login_profile(request: Optional[google.cloud.oslogin_v1.types.oslogin.GetLoginProfileRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

Parameters
Name	Description
`request`	`.oslogin.GetLoginProfileRequest` The request object. A request message for retrieving the login profile information for a user.
`name`	`str` Required. The unique ID for the user in format `users/{user}`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`.oslogin.LoginProfile`	The user profile information used for logging in to a virtual machine on Google Compute Engine.

get_ssh_public_key

get_ssh_public_key(request: Optional[google.cloud.oslogin_v1.types.oslogin.GetSshPublicKeyRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Retrieves an SSH public key.

Parameters
Name	Description
`request`	`.oslogin.GetSshPublicKeyRequest` The request object. A request message for retrieving an SSH public key.
`name`	`str` 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}`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`.common.SshPublicKey`	The SSH public key information associated with a Google account.

import_ssh_public_key

import_ssh_public_key(request: Optional[google.cloud.oslogin_v1.types.oslogin.ImportSshPublicKeyRequest] = None, *, parent: Optional[str] = None, ssh_public_key: Optional[google.cloud.oslogin_v1.common.types.common.SshPublicKey] = None, project_id: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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.

Parameters
Name	Description
`request`	`.oslogin.ImportSshPublicKeyRequest` The request object. A request message for importing an SSH public key.
`parent`	`str` Required. The unique ID for the user in format `users/{user}`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`ssh_public_key`	`.common.SshPublicKey` Optional. The SSH public key and expiration time. This corresponds to the `ssh_public_key` field on the `request` instance; if `request` is provided, this should not be set.
`project_id`	`str` The project ID of the Google Cloud Platform project. This corresponds to the `project_id` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`.oslogin.ImportSshPublicKeyResponse`	A response message for importing an SSH public key.

parse_ssh_public_key_path

parse_ssh_public_key_path(path: str)

Parse a ssh_public_key path into its component segments.

ssh_public_key_path

ssh_public_key_path(user: str, fingerprint: str)

Return a fully-qualified ssh_public_key string.

update_ssh_public_key

update_ssh_public_key(request: Optional[google.cloud.oslogin_v1.types.oslogin.UpdateSshPublicKeyRequest] = None, *, name: Optional[str] = None, ssh_public_key: Optional[google.cloud.oslogin_v1.common.types.common.SshPublicKey] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

Parameters
Name	Description
`request`	`.oslogin.UpdateSshPublicKeyRequest` The request object. A request message for updating an SSH public key.
`name`	`str` 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}`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`ssh_public_key`	`.common.SshPublicKey` Required. The SSH public key and expiration time. This corresponds to the `ssh_public_key` field on the `request` instance; if `request` is provided, this should not be set.
`update_mask`	`.field_mask.FieldMask` Mask to control which fields get updated. Updates all if not present. This corresponds to the `update_mask` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`.common.SshPublicKey`	The SSH public key information associated with a Google account.