Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
Google_Service_Computeaccounts_Users_Resource Class Reference

The "users" collection of methods. More...

Inheritance diagram for Google_Service_Computeaccounts_Users_Resource:
Google_Service_Resource

Public Member Functions

 addPublicKey ($project, $user, Google_Service_Computeaccounts_PublicKey $postBody, $optParams=array())
 Adds a public key to the specified user using the data included in the request.
 
 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 delete ($project, $user, $optParams=array())
 Deletes the specified user resource.
 
 get ($project, $user, $optParams=array())
 Returns the specified user resource.
 
 insert ($project, Google_Service_Computeaccounts_User $postBody, $optParams=array())
 Creates a user resource in the specified project using the data included in the request.
 
 listUsers ($project, $optParams=array())
 Retrieves the list of users contained within the specified project.
 
 removePublicKey ($project, $user, $fingerprint, $optParams=array())
 Removes the specified public key from the user.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "users" collection of methods.

Typical usage is: $computeaccountsService = new Google_Service_Computeaccounts(...); $users = $computeaccountsService->users;

Member Function Documentation

◆ addPublicKey()

Google_Service_Computeaccounts_Users_Resource::addPublicKey ( $project,
$user,
Google_Service_Computeaccounts_PublicKey $postBody,
$optParams = array() )

Adds a public key to the specified user using the data included in the request.

(users.addPublicKey)

Parameters
string$projectProject ID for this request.
string$userName of the user for this request.
Google_PublicKey$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Computeaccounts_Operation

◆ call()

Google_Service_Resource::call ( $name,
$arguments,
$expected_class = null )
inherited

TODO: This function needs simplifying.

Parameters
$name
$arguments
$expected_class- optional, the expected class name
Return values
Google_Http_Request|expected_class
Exceptions
Google_Exception

◆ delete()

Google_Service_Computeaccounts_Users_Resource::delete ( $project,
$user,
$optParams = array() )

Deletes the specified user resource.

(users.delete)

Parameters
string$projectProject ID for this request.
string$userName of the user resource to delete.
array$optParamsOptional parameters.
Return values
Google_Service_Computeaccounts_Operation

◆ get()

Google_Service_Computeaccounts_Users_Resource::get ( $project,
$user,
$optParams = array() )

Returns the specified user resource.

(users.get)

Parameters
string$projectProject ID for this request.
string$userName of the user resource to return.
array$optParamsOptional parameters.
Return values
Google_Service_Computeaccounts_User

◆ insert()

Google_Service_Computeaccounts_Users_Resource::insert ( $project,
Google_Service_Computeaccounts_User $postBody,
$optParams = array() )

Creates a user resource in the specified project using the data included in the request.

(users.insert)

Parameters
string$projectProject ID for this request.
Google_User$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Computeaccounts_Operation

◆ listUsers()

Google_Service_Computeaccounts_Users_Resource::listUsers ( $project,
$optParams = array() )

Retrieves the list of users contained within the specified project.

(users.listUsers)

Parameters
string$projectProject ID for this request.
array$optParamsOptional parameters.

@opt_param string filter Optional. Filter expression for filtering listed resources. @opt_param string pageToken Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request. @opt_param string maxResults Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.

Return values
Google_Service_Computeaccounts_UserList

◆ removePublicKey()

Google_Service_Computeaccounts_Users_Resource::removePublicKey ( $project,
$user,
$fingerprint,
$optParams = array() )

Removes the specified public key from the user.

(users.removePublicKey)

Parameters
string$projectProject ID for this request.
string$userName of the user for this request.
string$fingerprintThe 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.
array$optParamsOptional parameters.
Return values
Google_Service_Computeaccounts_Operation

The documentation for this class was generated from the following file: