Google Cloud OsLogin V1 Client - Class OsLoginServiceClient (2.1.3)

Reference documentation and code samples for the Google Cloud OsLogin V1 Client class OsLoginServiceClient.

Service Description: 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.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

Namespace

Google \ Cloud \ OsLogin \ V1 \ Client

Methods

__construct

Constructor.

Parameters

Name

Description

options

array| Google\ApiCore\Options\ClientOptions

Optional. Options for configuring the service API wrapper.

↳ apiEndpoint

string

The address of the API remote host. May optionally include the port, formatted as "

↳ credentials

FetchAuthTokenInterface|CredentialsWrapper

This option should only be used with a pre-constructed Google\Auth\FetchAuthTokenInterface or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. Important: If you are providing a path to a credentials file, or a decoded credentials file as a PHP array, this usage is now DEPRECATED. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. It is recommended to create the credentials explicitly use Google\Auth\Credentials\ServiceAccountCredentials; use Google\Cloud\OsLogin\V1\OsLoginServiceClient; $creds = new ServiceAccountCredentials($scopes, $json); $options = new OsLoginServiceClient(['credentials' => $creds]); https://cloud.google.com/docs/authentication/external/externally-sourced-credentials

↳ credentialsConfig

array

Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .

↳ disableRetries

bool

Determines whether or not retries defined by the client configuration should be disabled. Defaults to false .

↳ clientConfig

string|array

Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.

↳ transport

string|TransportInterface

The transport used for executing network requests. May be either the string rest or grpc . Defaults to grpc if gRPC support is detected on the system. Advanced usage : Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.

↳ transportConfig

array

Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.

↳ clientCertSource

callable

A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

↳ logger

false|LoggerInterface

A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag

↳ universeDomain

string

The service domain for the client. Defaults to 'googleapis.com'.

createSshPublicKey

Create an SSH public key

The async variant is OsLoginServiceClient::createSshPublicKeyAsync() .

Parameters

Name

Description

request

 Google\Cloud\OsLogin\V1\CreateSshPublicKeyRequest

A request to house fields associated with the call.

callOptions

array

Optional.

↳ retrySettings

RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns

Type

Description

 Google\Cloud\OsLogin\Common\SshPublicKey

Example

 use Google\ApiCore\ApiException;
use Google\Cloud\OsLogin\Common\SshPublicKey;
use Google\Cloud\OsLogin\V1\Client\OsLoginServiceClient;
use Google\Cloud\OsLogin\V1\CreateSshPublicKeyRequest;

/**
 * @param string $formattedParent The unique ID for the user in format `users/{user}`. Please see
 *                                {@see OsLoginServiceClient::userName()} for help formatting this field.
 */
function create_ssh_public_key_sample(string $formattedParent): void
{
    // Create a client.
    $osLoginServiceClient = new OsLoginServiceClient();

    // Prepare the request message.
    $sshPublicKey = new SshPublicKey();
    $request = (new CreateSshPublicKeyRequest())
        ->setParent($formattedParent)
        ->setSshPublicKey($sshPublicKey);

    // Call the API and handle any network failures.
    try {
        /** @var SshPublicKey $response */
        $response = $osLoginServiceClient->createSshPublicKey($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = OsLoginServiceClient::userName('[USER]');

    create_ssh_public_key_sample($formattedParent);
}

deletePosixAccount

Deletes a POSIX account.

The async variant is OsLoginServiceClient::deletePosixAccountAsync() .

Parameters

Name

Description

request

 Google\Cloud\OsLogin\V1\DeletePosixAccountRequest

A request to house fields associated with the call.

callOptions

array

Optional.

↳ retrySettings

RetrySettings|array

Example

 use Google\ApiCore\ApiException;
use Google\Cloud\OsLogin\V1\Client\OsLoginServiceClient;
use Google\Cloud\OsLogin\V1\DeletePosixAccountRequest;

/**
 * @param string $formattedName 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}`. Please see
 *                              {@see OsLoginServiceClient::posixAccountName()} for help formatting this field.
 */
function delete_posix_account_sample(string $formattedName): void
{
    // Create a client.
    $osLoginServiceClient = new OsLoginServiceClient();

    // Prepare the request message.
    $request = (new DeletePosixAccountRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        $osLoginServiceClient->deletePosixAccount($request);
        printf('Call completed successfully.' . PHP_EOL);
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = OsLoginServiceClient::posixAccountName('[USER]', '[PROJECT]');

    delete_posix_account_sample($formattedName);
}

deleteSshPublicKey

Deletes an SSH public key.

The async variant is OsLoginServiceClient::deleteSshPublicKeyAsync() .

Parameters

Name

Description

request

 Google\Cloud\OsLogin\V1\DeleteSshPublicKeyRequest

A request to house fields associated with the call.

callOptions

array

Optional.

↳ retrySettings

RetrySettings|array

Example

 use Google\ApiCore\ApiException;
use Google\Cloud\OsLogin\V1\Client\OsLoginServiceClient;
use Google\Cloud\OsLogin\V1\DeleteSshPublicKeyRequest;

/**
 * @param string $formattedName 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}`. Please see
 *                              {@see OsLoginServiceClient::sshPublicKeyName()} for help formatting this field.
 */
function delete_ssh_public_key_sample(string $formattedName): void
{
    // Create a client.
    $osLoginServiceClient = new OsLoginServiceClient();

    // Prepare the request message.
    $request = (new DeleteSshPublicKeyRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        $osLoginServiceClient->deleteSshPublicKey($request);
        printf('Call completed successfully.' . PHP_EOL);
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = OsLoginServiceClient::sshPublicKeyName('[USER]', '[FINGERPRINT]');

    delete_ssh_public_key_sample($formattedName);
}

getLoginProfile

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

The async variant is OsLoginServiceClient::getLoginProfileAsync() .

Parameters

Name

Description

request

 Google\Cloud\OsLogin\V1\GetLoginProfileRequest

A request to house fields associated with the call.

callOptions

array

Optional.

↳ retrySettings

RetrySettings|array

Returns

Type

Description

 Google\Cloud\OsLogin\V1\LoginProfile

Example

 use Google\ApiCore\ApiException;
use Google\Cloud\OsLogin\V1\Client\OsLoginServiceClient;
use Google\Cloud\OsLogin\V1\GetLoginProfileRequest;
use Google\Cloud\OsLogin\V1\LoginProfile;

/**
 * @param string $formattedName The unique ID for the user in format `users/{user}`. Please see
 *                              {@see OsLoginServiceClient::userName()} for help formatting this field.
 */
function get_login_profile_sample(string $formattedName): void
{
    // Create a client.
    $osLoginServiceClient = new OsLoginServiceClient();

    // Prepare the request message.
    $request = (new GetLoginProfileRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var LoginProfile $response */
        $response = $osLoginServiceClient->getLoginProfile($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = OsLoginServiceClient::userName('[USER]');

    get_login_profile_sample($formattedName);
}

getSshPublicKey

Retrieves an SSH public key.

The async variant is OsLoginServiceClient::getSshPublicKeyAsync() .

Parameters

Name

Description

request

 Google\Cloud\OsLogin\V1\GetSshPublicKeyRequest

A request to house fields associated with the call.

callOptions

array

Optional.

↳ retrySettings

RetrySettings|array

Returns

Type

Description

 Google\Cloud\OsLogin\Common\SshPublicKey

Example

 use Google\ApiCore\ApiException;
use Google\Cloud\OsLogin\Common\SshPublicKey;
use Google\Cloud\OsLogin\V1\Client\OsLoginServiceClient;
use Google\Cloud\OsLogin\V1\GetSshPublicKeyRequest;

/**
 * @param string $formattedName 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}`. Please see
 *                              {@see OsLoginServiceClient::sshPublicKeyName()} for help formatting this field.
 */
function get_ssh_public_key_sample(string $formattedName): void
{
    // Create a client.
    $osLoginServiceClient = new OsLoginServiceClient();

    // Prepare the request message.
    $request = (new GetSshPublicKeyRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var SshPublicKey $response */
        $response = $osLoginServiceClient->getSshPublicKey($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = OsLoginServiceClient::sshPublicKeyName('[USER]', '[FINGERPRINT]');

    get_ssh_public_key_sample($formattedName);
}

importSshPublicKey

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.

The async variant is OsLoginServiceClient::importSshPublicKeyAsync() .

Parameters

Name

Description

request

 Google\Cloud\OsLogin\V1\ImportSshPublicKeyRequest

A request to house fields associated with the call.

callOptions

array

Optional.

↳ retrySettings

RetrySettings|array

Returns

Type

Description

 Google\Cloud\OsLogin\V1\ImportSshPublicKeyResponse

Example

 use Google\ApiCore\ApiException;
use Google\Cloud\OsLogin\V1\Client\OsLoginServiceClient;
use Google\Cloud\OsLogin\V1\ImportSshPublicKeyRequest;
use Google\Cloud\OsLogin\V1\ImportSshPublicKeyResponse;

/**
 * @param string $formattedParent The unique ID for the user in format `users/{user}`. Please see
 *                                {@see OsLoginServiceClient::userName()} for help formatting this field.
 */
function import_ssh_public_key_sample(string $formattedParent): void
{
    // Create a client.
    $osLoginServiceClient = new OsLoginServiceClient();

    // Prepare the request message.
    $request = (new ImportSshPublicKeyRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var ImportSshPublicKeyResponse $response */
        $response = $osLoginServiceClient->importSshPublicKey($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = OsLoginServiceClient::userName('[USER]');

    import_ssh_public_key_sample($formattedParent);
}

updateSshPublicKey

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

The async variant is OsLoginServiceClient::updateSshPublicKeyAsync() .

Parameters

Name

Description

request

 Google\Cloud\OsLogin\V1\UpdateSshPublicKeyRequest

A request to house fields associated with the call.

callOptions

array

Optional.

↳ retrySettings

RetrySettings|array

Returns

Type

Description

 Google\Cloud\OsLogin\Common\SshPublicKey

Example

 use Google\ApiCore\ApiException;
use Google\Cloud\OsLogin\Common\SshPublicKey;
use Google\Cloud\OsLogin\V1\Client\OsLoginServiceClient;
use Google\Cloud\OsLogin\V1\UpdateSshPublicKeyRequest;

/**
 * @param string $formattedName 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}`. Please see
 *                              {@see OsLoginServiceClient::sshPublicKeyName()} for help formatting this field.
 */
function update_ssh_public_key_sample(string $formattedName): void
{
    // Create a client.
    $osLoginServiceClient = new OsLoginServiceClient();

    // Prepare the request message.
    $sshPublicKey = new SshPublicKey();
    $request = (new UpdateSshPublicKeyRequest())
        ->setName($formattedName)
        ->setSshPublicKey($sshPublicKey);

    // Call the API and handle any network failures.
    try {
        /** @var SshPublicKey $response */
        $response = $osLoginServiceClient->updateSshPublicKey($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = OsLoginServiceClient::sshPublicKeyName('[USER]', '[FINGERPRINT]');

    update_ssh_public_key_sample($formattedName);
}

createSshPublicKeyAsync

Parameters

Name

Description

request

 Google\Cloud\OsLogin\V1\CreateSshPublicKeyRequest

optionalArgs

array

Returns

Type

Description

 GuzzleHttp\Promise\PromiseInterface 
< Google\Cloud\OsLogin\Common\SshPublicKey 
>

deletePosixAccountAsync

Parameters

Name

Description

request

 Google\Cloud\OsLogin\V1\DeletePosixAccountRequest

optionalArgs

array

Returns

Type

Description

 GuzzleHttp\Promise\PromiseInterface 
< void 
>

deleteSshPublicKeyAsync

Parameters

Name

Description

request

 Google\Cloud\OsLogin\V1\DeleteSshPublicKeyRequest

optionalArgs

array

Returns

Type

Description

 GuzzleHttp\Promise\PromiseInterface 
< void 
>

getLoginProfileAsync

Parameters

Name

Description

request

 Google\Cloud\OsLogin\V1\GetLoginProfileRequest

optionalArgs

array

Returns

Type

Description

 GuzzleHttp\Promise\PromiseInterface 
< Google\Cloud\OsLogin\V1\LoginProfile 
>

getSshPublicKeyAsync

Parameters

Name

Description

request

 Google\Cloud\OsLogin\V1\GetSshPublicKeyRequest

optionalArgs

array

Returns

Type

Description

 GuzzleHttp\Promise\PromiseInterface 
< Google\Cloud\OsLogin\Common\SshPublicKey 
>

importSshPublicKeyAsync

Parameters

Name

Description

request

 Google\Cloud\OsLogin\V1\ImportSshPublicKeyRequest

optionalArgs

array

Returns

Type

Description

 GuzzleHttp\Promise\PromiseInterface 
< Google\Cloud\OsLogin\V1\ImportSshPublicKeyResponse 
>

updateSshPublicKeyAsync

Parameters

Name

Description

request

 Google\Cloud\OsLogin\V1\UpdateSshPublicKeyRequest

optionalArgs

array

Returns

Type

Description

 GuzzleHttp\Promise\PromiseInterface 
< Google\Cloud\OsLogin\Common\SshPublicKey 
>

static::posixAccountName

Formats a string containing the fully-qualified path to represent a posix_account resource.

Parameters

Name

Description

user

string

project

string

Returns

Type

Description

string

The formatted posix_account resource.

static::sshPublicKeyName

Formats a string containing the fully-qualified path to represent a ssh_public_key resource.

Parameters

Name

Description

user

string

fingerprint

string

Returns

Type

Description

string

The formatted ssh_public_key resource.

static::userName

Formats a string containing the fully-qualified path to represent a user resource.

Parameter

Name

Description

user

string

Returns

Type

Description

string

The formatted user resource.

static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

posixAccount: users/{user}/projects/{project}
sshPublicKey: users/{user}/sshPublicKeys/{fingerprint}
user: users/{user}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters

Name

Description

formattedName

string

The formatted name string

template

?string

Optional name of template to match

Returns

Type

Description

array

An associative array from name component IDs to component values.

Google Cloud OsLogin V1 Client - Class OsLoginServiceClient (2.1.3) Stay organized with collections Save and categorize content based on your preferences.

Namespace

Methods

__construct

createSshPublicKey

deletePosixAccount

deleteSshPublicKey

getLoginProfile

getSshPublicKey

importSshPublicKey

updateSshPublicKey

createSshPublicKeyAsync

deletePosixAccountAsync

deleteSshPublicKeyAsync

getLoginProfileAsync

getSshPublicKeyAsync

importSshPublicKeyAsync

updateSshPublicKeyAsync

static::posixAccountName

static::sshPublicKeyName

static::userName

static::parseName

Google Cloud OsLogin V1 Client - Class OsLoginServiceClient (2.1.3)