Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
Google_Service_CloudUserAccounts_Users_Resource Class Reference

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

Inheritance diagram for Google_Service_CloudUserAccounts_Users_Resource:
Google_Service_Resource

Public Member Functions

 addPublicKey ($project, $user, Google_Service_CloudUserAccounts_PublicKey $postBody, $optParams=array())
 Adds a public key to the specified User resource with 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.
 
 getIamPolicy ($project, $resource, $optParams=array())
 Gets the access control policy for a resource.
 
 insert ($project, Google_Service_CloudUserAccounts_User $postBody, $optParams=array())
 Creates a User resource in the specified project using the data included in the request.
 
 listUsers ($project, $optParams=array())
 Retrieves a list of users contained within the specified project.
 
 removePublicKey ($project, $user, $fingerprint, $optParams=array())
 Removes the specified public key from the user.
 
 setIamPolicy ($project, $resource, Google_Service_CloudUserAccounts_Policy $postBody, $optParams=array())
 Sets the access control policy on the specified resource.
 
 testIamPermissions ($project, $resource, Google_Service_CloudUserAccounts_TestPermissionsRequest $postBody, $optParams=array())
 Returns permissions that a caller has on the specified resource.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "users" collection of methods.

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

Member Function Documentation

◆ addPublicKey()

Google_Service_CloudUserAccounts_Users_Resource::addPublicKey ( $project,
$user,
Google_Service_CloudUserAccounts_PublicKey $postBody,
$optParams = array() )

Adds a public key to the specified User resource with 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_CloudUserAccounts_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_CloudUserAccounts_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_CloudUserAccounts_Operation

◆ get()

Google_Service_CloudUserAccounts_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_CloudUserAccounts_User

◆ getIamPolicy()

Google_Service_CloudUserAccounts_Users_Resource::getIamPolicy ( $project,
$resource,
$optParams = array() )

Gets the access control policy for a resource.

May be empty if no such policy or resource exists. (users.getIamPolicy)

Parameters
string$projectProject ID for this request.
string$resourceName of the resource for this request.
array$optParamsOptional parameters.
Return values
Google_Service_CloudUserAccounts_Policy

◆ insert()

Google_Service_CloudUserAccounts_Users_Resource::insert ( $project,
Google_Service_CloudUserAccounts_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_CloudUserAccounts_Operation

◆ listUsers()

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

Retrieves a list of users contained within the specified project.

(users.listUsers)

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

@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 (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, filter=name ne example-instance. @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 maxResults Maximum count of results to be returned. @opt_param string pageToken Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.

Return values
Google_Service_CloudUserAccounts_UserList

◆ removePublicKey()

Google_Service_CloudUserAccounts_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_CloudUserAccounts_Operation

◆ setIamPolicy()

Google_Service_CloudUserAccounts_Users_Resource::setIamPolicy ( $project,
$resource,
Google_Service_CloudUserAccounts_Policy $postBody,
$optParams = array() )

Sets the access control policy on the specified resource.

Replaces any existing policy. (users.setIamPolicy)

Parameters
string$projectProject ID for this request.
string$resourceName of the resource for this request.
Google_Policy$postBody
array$optParamsOptional parameters.
Return values
Google_Service_CloudUserAccounts_Policy

◆ testIamPermissions()

Google_Service_CloudUserAccounts_Users_Resource::testIamPermissions ( $project,
$resource,
Google_Service_CloudUserAccounts_TestPermissionsRequest $postBody,
$optParams = array() )

Returns permissions that a caller has on the specified resource.

(users.testIamPermissions)

Parameters
string$projectProject ID for this request.
string$resourceName of the resource for this request.
Google_TestPermissionsRequest$postBody
array$optParamsOptional parameters.
Return values
Google_Service_CloudUserAccounts_TestPermissionsResponse

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