Class OsLoginServiceAsyncClient (2.11.0)

OsLoginServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.oslogin_v1.services.os_login_service.transports.base.OsLoginServiceTransport] = 'grpc_asyncio', client_options: typing.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

Returns the transport used by the client instance.

Returns
Type	Description
`OsLoginServiceTransport`	The transport used by the client instance.

Methods

OsLoginServiceAsyncClient

OsLoginServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.oslogin_v1.services.os_login_service.transports.base.OsLoginServiceTransport] = 'grpc_asyncio', client_options: typing.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>)

Instantiates 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`	`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.

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) -> str

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

create_ssh_public_key

create_ssh_public_key(
    request: typing.Optional[
        typing.Union[
            google.cloud.oslogin_v1.types.oslogin.CreateSshPublicKeyRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    ssh_public_key: typing.Optional[
        google.cloud.oslogin_v1.common.types.common.SshPublicKey
    ] = None,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.oslogin_v1.common.types.common.SshPublicKey

Create an SSH public key

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import oslogin_v1

async def sample_create_ssh_public_key():
    # Create a client
    client = oslogin_v1.OsLoginServiceAsyncClient()

    # Initialize request argument(s)
    request = oslogin_v1.CreateSshPublicKeyRequest(
        parent="parent_value",
    )

    # Make the request
    response = await client.create_ssh_public_key(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.oslogin_v1.types.CreateSshPublicKeyRequest, dict]]` The request object. A request message for creating 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`	`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.
`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.types.SshPublicKey`	The SSH public key information associated with a Google account.

delete_posix_account

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

Deletes a POSIX account.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import oslogin_v1

async def sample_delete_posix_account():
    # Create a client
    client = oslogin_v1.OsLoginServiceAsyncClient()

    # Initialize request argument(s)
    request = oslogin_v1.DeletePosixAccountRequest(
        name="name_value",
    )

    # Make the request
    await client.delete_posix_account(request=request)

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.oslogin_v1.types.DeletePosixAccountRequest, dict]]` 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: typing.Optional[
        typing.Union[
            google.cloud.oslogin_v1.types.oslogin.DeleteSshPublicKeyRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Deletes an SSH public key.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import oslogin_v1

async def sample_delete_ssh_public_key():
    # Create a client
    client = oslogin_v1.OsLoginServiceAsyncClient()

    # Initialize request argument(s)
    request = oslogin_v1.DeleteSshPublicKeyRequest(
        name="name_value",
    )

    # Make the request
    await client.delete_ssh_public_key(request=request)

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.oslogin_v1.types.DeleteSshPublicKeyRequest, dict]]` 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
`OsLoginServiceAsyncClient`	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
`OsLoginServiceAsyncClient`	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
`OsLoginServiceAsyncClient`	The constructed client.

get_login_profile

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

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import oslogin_v1

async def sample_get_login_profile():
    # Create a client
    client = oslogin_v1.OsLoginServiceAsyncClient()

    # Initialize request argument(s)
    request = oslogin_v1.GetLoginProfileRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_login_profile(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.oslogin_v1.types.GetLoginProfileRequest, dict]]` 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
`google.cloud.oslogin_v1.types.LoginProfile`	The user profile information used for logging in to a virtual machine on Google Compute Engine.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variable is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameter
Name	Description
`client_options`	`google.api_core.client_options.ClientOptions` Custom options for the client. Only the `api_endpoint` and `client_cert_source` properties may be used in this method.

Exceptions
Type	Description
`google.auth.exceptions.MutualTLSChannelError`	If any errors happen.

Returns
Type	Description
`Tuple[str, Callable[[], Tuple[bytes, bytes]]]`	returns the API endpoint and the client cert source to use.

get_ssh_public_key

get_ssh_public_key(
    request: typing.Optional[
        typing.Union[google.cloud.oslogin_v1.types.oslogin.GetSshPublicKeyRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.oslogin_v1.common.types.common.SshPublicKey

Retrieves an SSH public key.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import oslogin_v1

async def sample_get_ssh_public_key():
    # Create a client
    client = oslogin_v1.OsLoginServiceAsyncClient()

    # Initialize request argument(s)
    request = oslogin_v1.GetSshPublicKeyRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_ssh_public_key(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.oslogin_v1.types.GetSshPublicKeyRequest, dict]]` 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
`google.cloud.oslogin_v1.common.types.SshPublicKey`	The SSH public key information associated with a Google account.

get_transport_class

get_transport_class() -> (
    typing.Type[
        google.cloud.oslogin_v1.services.os_login_service.transports.base.OsLoginServiceTransport
    ]
)

Returns an appropriate transport class.

import_ssh_public_key

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

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import oslogin_v1

async def sample_import_ssh_public_key():
    # Create a client
    client = oslogin_v1.OsLoginServiceAsyncClient()

    # Initialize request argument(s)
    request = oslogin_v1.ImportSshPublicKeyRequest(
        parent="parent_value",
    )

    # Make the request
    response = await client.import_ssh_public_key(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.oslogin_v1.types.ImportSshPublicKeyRequest, dict]]` 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`	`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
`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) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

parse_posix_account_path

parse_posix_account_path(path: str) -> typing.Dict[str, str]

Parses a posix_account path into its component segments.

parse_ssh_public_key_path

parse_ssh_public_key_path(path: str) -> typing.Dict[str, str]

Parses a ssh_public_key path into its component segments.

posix_account_path

posix_account_path(user: str, project: str) -> str

Returns a fully-qualified posix_account string.

ssh_public_key_path

ssh_public_key_path(user: str, fingerprint: str) -> str

Returns a fully-qualified ssh_public_key string.

update_ssh_public_key

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

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import oslogin_v1

async def sample_update_ssh_public_key():
    # Create a client
    client = oslogin_v1.OsLoginServiceAsyncClient()

    # Initialize request argument(s)
    request = oslogin_v1.UpdateSshPublicKeyRequest(
        name="name_value",
    )

    # Make the request
    response = await client.update_ssh_public_key(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.oslogin_v1.types.UpdateSshPublicKeyRequest, dict]]` 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`	`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`	`google.protobuf.field_mask_pb2.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
`google.cloud.oslogin_v1.common.types.SshPublicKey`	The SSH public key information associated with a Google account.