Viewing file:  Users.php (10.69 KB) -rwxrwxrwx
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
/**
* The "users" collection of methods.
* Typical usage is:
* <code>
* $adminService = new Google_Service_Directory(...);
* $users = $adminService->users;
* </code>
*/
class Google_Service_Directory_Resource_Users extends Google_Service_Resource
{
/**
* Deletes a user. (users.delete)
*
* @param string $userKey Identifies the user in the API request. The value can
* be the user's primary email address, alias email address, or unique user ID.
* @param array $optParams Optional parameters.
*/
public function delete($userKey, $optParams = array())
{
$params = array('userKey' => $userKey);
$params = array_merge($params, $optParams);
return $this->call('delete', array($params));
}
/**
* Retrieves a user. (users.get)
*
* @param string $userKey Identifies the user in the API request. The value can
* be the user's primary email address, alias email address, or unique user ID.
* @param array $optParams Optional parameters.
*
* @opt_param string customFieldMask A comma-separated list of schema names. All
* fields from these schemas are fetched. This should only be set when
* `projection=custom`.
* @opt_param string projection What subset of fields to fetch for this user.
* @opt_param string viewType Whether to fetch the administrator-only or domain-
* wide public view of the user. For more information, see [Retrieve a user as a
* non-administrator](/admin-sdk/directory/v1/guides/manage-
* users#retrieve_users_non_admin).
* @return Google_Service_Directory_User
*/
public function get($userKey, $optParams = array())
{
$params = array('userKey' => $userKey);
$params = array_merge($params, $optParams);
return $this->call('get', array($params), "Google_Service_Directory_User");
}
/**
* Creates a user. (users.insert)
*
* @param Google_Service_Directory_User $postBody
* @param array $optParams Optional parameters.
* @return Google_Service_Directory_User
*/
public function insert(Google_Service_Directory_User $postBody, $optParams = array())
{
$params = array('postBody' => $postBody);
$params = array_merge($params, $optParams);
return $this->call('insert', array($params), "Google_Service_Directory_User");
}
/**
* Retrieves a paginated list of either deleted users or all users in a domain.
* (users.listUsers)
*
* @param array $optParams Optional parameters.
*
* @opt_param string customFieldMask A comma-separated list of schema names. All
* fields from these schemas are fetched. This should only be set when
* `projection=custom`.
* @opt_param string customer The unique ID for the customer's Google Workspace
* account. In case of a multi-domain account, to fetch all groups for a
* customer, fill this field instead of domain. You can also use the
* `my_customer` alias to represent your account's `customerId`. The
* `customerId` is also returned as part of the [Users resource](/admin-
* sdk/directory/v1/reference/users). Either the `customer` or the `domain`
* parameter must be provided.
* @opt_param string domain The domain name. Use this field to get fields from
* only one domain. To return all domains for a customer account, use the
* `customer` query parameter instead. Either the `customer` or the `domain`
* parameter must be provided.
* @opt_param string event Event on which subscription is intended (if
* subscribing)
* @opt_param int maxResults Maximum number of results to return.
* @opt_param string orderBy Property to use for sorting results.
* @opt_param string pageToken Token to specify next page in the list
* @opt_param string projection What subset of fields to fetch for this user.
* @opt_param string query Query string for searching user fields. For more
* information on constructing user queries, see [Search for Users](/admin-
* sdk/directory/v1/guides/search-users).
* @opt_param string showDeleted If set to `true`, retrieves the list of deleted
* users. (Default: `false`)
* @opt_param string sortOrder Whether to return results in ascending or
* descending order.
* @opt_param string viewType Whether to fetch the administrator-only or domain-
* wide public view of the user. For more information, see [Retrieve a user as a
* non-administrator](/admin-sdk/directory/v1/guides/manage-
* users#retrieve_users_non_admin).
* @return Google_Service_Directory_Users
*/
public function listUsers($optParams = array())
{
$params = array();
$params = array_merge($params, $optParams);
return $this->call('list', array($params), "Google_Service_Directory_Users");
}
/**
* Makes a user a super administrator. (users.makeAdmin)
*
* @param string $userKey Identifies the user in the API request. The value can
* be the user's primary email address, alias email address, or unique user ID.
* @param Google_Service_Directory_UserMakeAdmin $postBody
* @param array $optParams Optional parameters.
*/
public function makeAdmin($userKey, Google_Service_Directory_UserMakeAdmin $postBody, $optParams = array())
{
$params = array('userKey' => $userKey, 'postBody' => $postBody);
$params = array_merge($params, $optParams);
return $this->call('makeAdmin', array($params));
}
/**
* Updates a user using patch semantics. The update method should be used
* instead, since it also supports patch semantics and has better performance.
* This method is unable to clear fields that contain repeated objects
* (`addresses`, `phones`, etc). Use the update method instead. (users.patch)
*
* @param string $userKey Identifies the user in the API request. The value can
* be the user's primary email address, alias email address, or unique user ID.
* @param Google_Service_Directory_User $postBody
* @param array $optParams Optional parameters.
* @return Google_Service_Directory_User
*/
public function patch($userKey, Google_Service_Directory_User $postBody, $optParams = array())
{
$params = array('userKey' => $userKey, 'postBody' => $postBody);
$params = array_merge($params, $optParams);
return $this->call('patch', array($params), "Google_Service_Directory_User");
}
/**
* Sign a user out of all web and device sessions and reset their sign-in
* cookies. User will have to sign in by authenticating again. (users.signOut)
*
* @param string $userKey Identifies the target user in the API request. The
* value can be the user's primary email address, alias email address, or unique
* user ID.
* @param array $optParams Optional parameters.
*/
public function signOut($userKey, $optParams = array())
{
$params = array('userKey' => $userKey);
$params = array_merge($params, $optParams);
return $this->call('signOut', array($params));
}
/**
* Undeletes a deleted user. (users.undelete)
*
* @param string $userKey The immutable id of the user
* @param Google_Service_Directory_UserUndelete $postBody
* @param array $optParams Optional parameters.
*/
public function undelete($userKey, Google_Service_Directory_UserUndelete $postBody, $optParams = array())
{
$params = array('userKey' => $userKey, 'postBody' => $postBody);
$params = array_merge($params, $optParams);
return $this->call('undelete', array($params));
}
/**
* Updates a user. This method supports patch semantics, meaning you only need
* to include the fields you wish to update. Fields that are not present in the
* request will be preserved, and fields set to `null` will be cleared.
* (users.update)
*
* @param string $userKey Identifies the user in the API request. The value can
* be the user's primary email address, alias email address, or unique user ID.
* @param Google_Service_Directory_User $postBody
* @param array $optParams Optional parameters.
* @return Google_Service_Directory_User
*/
public function update($userKey, Google_Service_Directory_User $postBody, $optParams = array())
{
$params = array('userKey' => $userKey, 'postBody' => $postBody);
$params = array_merge($params, $optParams);
return $this->call('update', array($params), "Google_Service_Directory_User");
}
/**
* Watch for changes in users list (users.watch)
*
* @param Google_Service_Directory_Channel $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string customFieldMask Comma-separated list of schema names. All
* fields from these schemas are fetched. This should only be set when
* projection=custom.
* @opt_param string customer Immutable ID of the Google Workspace account. In
* case of multi-domain, to fetch all users for a customer, fill this field
* instead of domain.
* @opt_param string domain Name of the domain. Fill this field to get users
* from only this domain. To return all users in a multi-domain fill customer
* field instead."
* @opt_param string event Events to watch for.
* @opt_param int maxResults Maximum number of results to return.
* @opt_param string orderBy Column to use for sorting results
* @opt_param string pageToken Token to specify next page in the list
* @opt_param string projection What subset of fields to fetch for this user.
* @opt_param string query Query string search. Should be of the form "".
* Complete documentation is at https: //developers.google.com/admin-
* sdk/directory/v1/guides/search-users
* @opt_param string showDeleted If set to true, retrieves the list of deleted
* users. (Default: false)
* @opt_param string sortOrder Whether to return results in ascending or
* descending order.
* @opt_param string viewType Whether to fetch the administrator-only or domain-
* wide public view of the user. For more information, see [Retrieve a user as a
* non-administrator](/admin-sdk/directory/v1/guides/manage-
* users#retrieve_users_non_admin).
* @return Google_Service_Directory_Channel
*/
public function watch(Google_Service_Directory_Channel $postBody, $optParams = array())
{
$params = array('postBody' => $postBody);
$params = array_merge($params, $optParams);
return $this->call('watch', array($params), "Google_Service_Directory_Channel");
}
}
|