Documentation

Google_Service_CloudUserAccounts_Resource_Users extends Google_Service_Resource
in package

The "users" collection of methods.

Typical usage is: $clouduseraccountsService = new Google_Service_CloudUserAccounts(...); $users = $clouduseraccountsService->users;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
addPublicKey()  : Google_Service_CloudUserAccounts_Operation
Adds a public key to the specified User resource with the data included in the request. (users.addPublicKey)
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_CloudUserAccounts_Operation
Deletes the specified User resource. (users.delete)
get()  : Google_Service_CloudUserAccounts_User
Returns the specified User resource. (users.get)
getIamPolicy()  : Google_Service_CloudUserAccounts_Policy
Gets the access control policy for a resource. May be empty if no such policy or resource exists. (users.getIamPolicy)
insert()  : Google_Service_CloudUserAccounts_Operation
Creates a User resource in the specified project using the data included in the request. (users.insert)
listUsers()  : Google_Service_CloudUserAccounts_UserList
Retrieves a list of users contained within the specified project.
removePublicKey()  : Google_Service_CloudUserAccounts_Operation
Removes the specified public key from the user. (users.removePublicKey)
setIamPolicy()  : Google_Service_CloudUserAccounts_Policy
Sets the access control policy on the specified resource. Replaces any existing policy. (users.setIamPolicy)
testIamPermissions()  : Google_Service_CloudUserAccounts_TestPermissionsResponse
Returns permissions that a caller has on the specified resource.
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 —

addPublicKey()

Adds a public key to the specified User resource with the data included in the request. (users.addPublicKey)

public addPublicKey(string $project, string $user, Google_Service_CloudUserAccounts_PublicKey $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudUserAccounts_Operation
Parameters
$project : string

Project ID for this request.

$user : string

Name of the user for this request.

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

Optional parameters.

Return values
Google_Service_CloudUserAccounts_Operation —

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

get()

Returns the specified User resource. (users.get)

public get(string $project, string $user[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudUserAccounts_User
Parameters
$project : string

Project ID for this request.

$user : string

Name of the user resource to return.

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

Optional parameters.

Return values
Google_Service_CloudUserAccounts_User —

getIamPolicy()

Gets the access control policy for a resource. May be empty if no such policy or resource exists. (users.getIamPolicy)

public getIamPolicy(string $project, string $resource[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudUserAccounts_Policy
Parameters
$project : string

Project ID for this request.

$resource : string

Name of the resource for this request.

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

Optional parameters.

Return values
Google_Service_CloudUserAccounts_Policy —

insert()

Creates a User resource in the specified project using the data included in the request. (users.insert)

public insert(string $project, Google_Service_CloudUserAccounts_User $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudUserAccounts_Operation
Parameters
$project : string

Project ID for this request.

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

Optional parameters.

Return values
Google_Service_CloudUserAccounts_Operation —

listUsers()

Retrieves a list of users contained within the specified project.

public listUsers(string $project[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudUserAccounts_UserList

(users.listUsers)

Parameters
$project : string

Project ID for this request.

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

Optional parameters.

Tags
opt_param

string filter Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.

The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

For example, to filter for instances that do not have a name of example- instance, you would use filter=name ne example-instance.

Compute Engine Beta API Only: If you use filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter results based on label values.

The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

opt_param

string maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.

opt_param

string orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

opt_param

string pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

Return values
Google_Service_CloudUserAccounts_UserList —

removePublicKey()

Removes the specified public key from the user. (users.removePublicKey)

public removePublicKey(string $project, string $user, string $fingerprint[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudUserAccounts_Operation
Parameters
$project : string

Project ID for this request.

$user : string

Name of the user for this request.

$fingerprint : string

The fingerprint of the public key to delete. Public keys are identified by their fingerprint, which is defined by RFC4716 to be the MD5 digest of the public key.

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

Optional parameters.

Return values
Google_Service_CloudUserAccounts_Operation —

setIamPolicy()

Sets the access control policy on the specified resource. Replaces any existing policy. (users.setIamPolicy)

public setIamPolicy(string $project, string $resource, Google_Service_CloudUserAccounts_Policy $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudUserAccounts_Policy
Parameters
$project : string

Project ID for this request.

$resource : string

Name of the resource for this request.

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

Optional parameters.

Return values
Google_Service_CloudUserAccounts_Policy —

testIamPermissions()

Returns permissions that a caller has on the specified resource.

public testIamPermissions(string $project, string $resource, Google_Service_CloudUserAccounts_TestPermissionsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudUserAccounts_TestPermissionsResponse

(users.testIamPermissions)

Parameters
$project : string

Project ID for this request.

$resource : string

Name of the resource for this request.

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

Optional parameters.

Return values
Google_Service_CloudUserAccounts_TestPermissionsResponse —

convertToArrayAndStripNulls()

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

Search results