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.
Properties
transport
Return the transport used by the client instance.
Returns | |
---|---|
Type | Description |
OsLoginServiceTransport | The transport used by the client instance. |
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 |
google.api_core.client_options.ClientOptions
Custom options for the client. It won't take effect if a |
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 |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If mutual TLS transport creation failed for any reason. |
common_billing_account_path
common_billing_account_path(billing_account: str)
Return a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)
Return a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)
Return a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)
Return a fully-qualified organization string.
common_project_path
common_project_path(project: str)
Return a fully-qualified project string.
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 |
google.cloud.oslogin_v1.types.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 |
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 |
google.cloud.oslogin_v1.types.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 |
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 |
OsLoginServiceClient | The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
Parameter | |
---|---|
Name | Description |
info |
dict
The service account private key info. |
Returns | |
---|---|
Type | Description |
OsLoginServiceClient | 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 |
OsLoginServiceClient | 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 |
google.cloud.oslogin_v1.types.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 |
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 |
google.cloud.oslogin_v1.types.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 |
google.cloud.oslogin_v1.types.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 |
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 |
google.cloud.oslogin.v1.common_pb2.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 |
google.cloud.oslogin_v1.types.ImportSshPublicKeyRequest
The request object. A request message for importing an SSH public key. |
parent |
str
Required. The unique ID for the user in format |
ssh_public_key |
google.cloud.oslogin.v1.common_pb2.SshPublicKey
Optional. The SSH public key and expiration time. This corresponds to the |
project_id |
str
The project ID of the Google Cloud Platform project. This corresponds to the |
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 |
google.cloud.oslogin_v1.types.ImportSshPublicKeyResponse | A response message for importing an SSH public key. |
parse_common_billing_account_path
parse_common_billing_account_path(path: str)
Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)
Parse a project path into its component segments.
parse_posix_account_path
parse_posix_account_path(path: str)
Parse a posix_account path into its component segments.
parse_ssh_public_key_path
parse_ssh_public_key_path(path: str)
Parse a ssh_public_key path into its component segments.
posix_account_path
posix_account_path(user: str, project: str)
Return a fully-qualified posix_account string.
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 |
google.cloud.oslogin_v1.types.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 |
ssh_public_key |
google.cloud.oslogin.v1.common_pb2.SshPublicKey
Required. The SSH public key and expiration time. This corresponds to the |
update_mask |
google.protobuf.field_mask_pb2.FieldMask
Mask to control which fields get updated. Updates all if not present. This corresponds to the |
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 |
google.cloud.oslogin.v1.common_pb2.SshPublicKey | The SSH public key information associated with a Google account. |