Documentation

Google_Service_CloudOSLogin_Resource_Users extends Google_Service_Resource
in package

The "users" collection of methods.

Typical usage is: $osloginService = new Google_Service_CloudOSLogin(...); $users = $osloginService->users;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
getLoginProfile()  : Google_Service_CloudOSLogin_LoginProfile
Retrieves the profile information used for logging in to a virtual machine on Google Compute Engine. (users.getLoginProfile)
importSshPublicKey()  : Google_Service_CloudOSLogin_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. (users.importSshPublicKey)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

getLoginProfile()

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

public getLoginProfile(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudOSLogin_LoginProfile
Parameters
$name : string

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

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string projectId The project ID of the Google Cloud Platform project.

opt_param

string systemId A system ID for filtering the results of the request.

Return values
Google_Service_CloudOSLogin_LoginProfile —

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. (users.importSshPublicKey)

public importSshPublicKey(string $parent, Google_Service_CloudOSLogin_SshPublicKey $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudOSLogin_ImportSshPublicKeyResponse
Parameters
$parent : string

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

$postBody : Google_Service_CloudOSLogin_SshPublicKey
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string projectId The project ID of the Google Cloud Platform project.

Return values
Google_Service_CloudOSLogin_ImportSshPublicKeyResponse —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results