Overview

Classes

  • Google_Service_Directory
  • Google_Service_Directory_Alias
  • Google_Service_Directory_Aliases
  • Google_Service_Directory_Asp
  • Google_Service_Directory_Asps
  • Google_Service_Directory_Asps_Resource
  • Google_Service_Directory_Building
  • Google_Service_Directory_BuildingAddress
  • Google_Service_Directory_BuildingCoordinates
  • Google_Service_Directory_Buildings
  • Google_Service_Directory_CalendarResource
  • Google_Service_Directory_CalendarResources
  • Google_Service_Directory_Channel
  • Google_Service_Directory_Channels_Resource
  • Google_Service_Directory_ChromeOsDevice
  • Google_Service_Directory_ChromeOsDeviceAction
  • Google_Service_Directory_ChromeOsDeviceActiveTimeRanges
  • Google_Service_Directory_ChromeOsDeviceCpuStatusReports
  • Google_Service_Directory_ChromeOsDeviceCpuStatusReportsCpuTemperatureInfo
  • Google_Service_Directory_ChromeOsDeviceDeviceFiles
  • Google_Service_Directory_ChromeOsDeviceDiskVolumeReports
  • Google_Service_Directory_ChromeOsDeviceDiskVolumeReportsVolumeInfo
  • Google_Service_Directory_ChromeOsDeviceRecentUsers
  • Google_Service_Directory_ChromeOsDevices
  • Google_Service_Directory_Chromeosdevices_Resource
  • Google_Service_Directory_ChromeOsDeviceSystemRamFreeReports
  • Google_Service_Directory_ChromeOsDeviceTpmVersionInfo
  • Google_Service_Directory_ChromeOsMoveDevicesToOu
  • Google_Service_Directory_Customer
  • Google_Service_Directory_CustomerPostalAddress
  • Google_Service_Directory_Customers_Resource
  • Google_Service_Directory_DomainAlias
  • Google_Service_Directory_DomainAliases
  • Google_Service_Directory_DomainAliases_Resource
  • Google_Service_Directory_Domains
  • Google_Service_Directory_Domains2
  • Google_Service_Directory_Domains_Resource
  • Google_Service_Directory_Feature
  • Google_Service_Directory_FeatureInstance
  • Google_Service_Directory_FeatureRename
  • Google_Service_Directory_Features
  • Google_Service_Directory_Group
  • Google_Service_Directory_Groups
  • Google_Service_Directory_Groups_Resource
  • Google_Service_Directory_GroupsAliases_Resource
  • Google_Service_Directory_Member
  • Google_Service_Directory_Members
  • Google_Service_Directory_Members_Resource
  • Google_Service_Directory_MembersHasMember
  • Google_Service_Directory_MobileDevice
  • Google_Service_Directory_MobileDeviceAction
  • Google_Service_Directory_MobileDeviceApplications
  • Google_Service_Directory_MobileDevices
  • Google_Service_Directory_Mobiledevices_Resource
  • Google_Service_Directory_Notification
  • Google_Service_Directory_Notifications
  • Google_Service_Directory_Notifications_Resource
  • Google_Service_Directory_OrgUnit
  • Google_Service_Directory_OrgUnits
  • Google_Service_Directory_Orgunits_Resource
  • Google_Service_Directory_Privilege
  • Google_Service_Directory_Privileges
  • Google_Service_Directory_Privileges_Resource
  • Google_Service_Directory_Resources_Resource
  • Google_Service_Directory_ResourcesBuildings_Resource
  • Google_Service_Directory_ResourcesCalendars_Resource
  • Google_Service_Directory_ResourcesFeatures_Resource
  • Google_Service_Directory_Role
  • Google_Service_Directory_RoleAssignment
  • Google_Service_Directory_RoleAssignments
  • Google_Service_Directory_RoleAssignments_Resource
  • Google_Service_Directory_RoleRolePrivileges
  • Google_Service_Directory_Roles
  • Google_Service_Directory_Roles_Resource
  • Google_Service_Directory_Schema
  • Google_Service_Directory_SchemaFieldSpec
  • Google_Service_Directory_SchemaFieldSpecNumericIndexingSpec
  • Google_Service_Directory_Schemas
  • Google_Service_Directory_Schemas_Resource
  • Google_Service_Directory_Token
  • Google_Service_Directory_Tokens
  • Google_Service_Directory_Tokens_Resource
  • Google_Service_Directory_User
  • Google_Service_Directory_UserAbout
  • Google_Service_Directory_UserAddress
  • Google_Service_Directory_UserEmail
  • Google_Service_Directory_UserExternalId
  • Google_Service_Directory_UserGender
  • Google_Service_Directory_UserIm
  • Google_Service_Directory_UserKeyword
  • Google_Service_Directory_UserLanguage
  • Google_Service_Directory_UserLocation
  • Google_Service_Directory_UserMakeAdmin
  • Google_Service_Directory_UserName
  • Google_Service_Directory_UserOrganization
  • Google_Service_Directory_UserPhone
  • Google_Service_Directory_UserPhoto
  • Google_Service_Directory_UserPosixAccount
  • Google_Service_Directory_UserRelation
  • Google_Service_Directory_Users
  • Google_Service_Directory_Users_Resource
  • Google_Service_Directory_UsersAliases_Resource
  • Google_Service_Directory_UsersPhotos_Resource
  • Google_Service_Directory_UserSshPublicKey
  • Google_Service_Directory_UserUndelete
  • Google_Service_Directory_UserWebsite
  • Google_Service_Directory_VerificationCode
  • Google_Service_Directory_VerificationCodes
  • Google_Service_Directory_VerificationCodes_Resource
  • Overview
  • Class
  • Tree

Class Google_Service_Directory_Users_Resource

The "users" collection of methods. Typical usage is:

 $adminService = new Google_Service_Directory(...);
 $users = $adminService->users;
Google_Service_Resource
Extended by Google_Service_Directory_Users_Resource
Located at Directory.php
Methods summary
public
# delete( string $userKey, array $optParams = array() )

Delete user (users.delete)

Delete user (users.delete)

Parameters

$userKey
Email or immutable ID of the user
$optParams
Optional parameters.
public Google_Service_Directory_User
# get( string $userKey, array $optParams = array() )

retrieve user (users.get)

retrieve user (users.get)

Parameters

$userKey
Email or immutable ID of the user
$optParams
Optional parameters.

Returns

Google_Service_Directory_User
Google_Service_Directory_User

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.
string projection What subset of fields to fetch for this user.
string viewType Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.
public Google_Service_Directory_User
# insert( Google_Service_Directory_User $postBody, array $optParams = array() )

create user. (users.insert)

create user. (users.insert)

Parameters

$postBody
$optParams
Optional parameters.

Returns

Google_Service_Directory_User
Google_Service_Directory_User
public Google_Service_Directory_Users
# listUsers( array $optParams = array() )

Retrieve either deleted users or all users in a domain (paginated) (users.listUsers)

Retrieve either deleted users or all users in a domain (paginated) (users.listUsers)

Parameters

$optParams
Optional parameters.

Returns

Google_Service_Directory_Users
Google_Service_Directory_Users

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.
string customer Immutable ID of the G Suite account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain.
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.
string event Event on which subscription is intended (if subscribing)
int maxResults Maximum number of results to return.
string orderBy Column to use for sorting results
string pageToken Token to specify next page in the list
string projection What subset of fields to fetch for this user.
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
string showDeleted If set to true, retrieves the list of deleted users. (Default: false)
string sortOrder Whether to return results in ascending or descending order.
string viewType Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.
public
# makeAdmin( string $userKey, Google_Service_Directory_UserMakeAdmin $postBody, array $optParams = array() )

change admin status of a user (users.makeAdmin)

change admin status of a user (users.makeAdmin)

Parameters

$userKey
Email or immutable ID of the user as admin
$postBody
$optParams
Optional parameters.
public Google_Service_Directory_User
# patch( string $userKey, Google_Service_Directory_User $postBody, array $optParams = array() )

update user. This method supports patch semantics. (users.patch)

update user. This method supports patch semantics. (users.patch)

Parameters

$userKey
Email or immutable ID of the user. If ID, it should match with id of user object
$postBody
$optParams
Optional parameters.

Returns

Google_Service_Directory_User
Google_Service_Directory_User
public
# undelete( string $userKey, Google_Service_Directory_UserUndelete $postBody, array $optParams = array() )

Undelete a deleted user (users.undelete)

Undelete a deleted user (users.undelete)

Parameters

$userKey
The immutable id of the user
$postBody
$optParams
Optional parameters.
public Google_Service_Directory_User
# update( string $userKey, Google_Service_Directory_User $postBody, array $optParams = array() )

update user (users.update)

update user (users.update)

Parameters

$userKey
Email or immutable ID of the user. If ID, it should match with id of user object
$postBody
$optParams
Optional parameters.

Returns

Google_Service_Directory_User
Google_Service_Directory_User
public Google_Service_Directory_Channel
# watch( Google_Service_Directory_Channel $postBody, array $optParams = array() )

Watch for changes in users list (users.watch)

Watch for changes in users list (users.watch)

Parameters

$postBody
$optParams
Optional parameters.

Returns

Google_Service_Directory_Channel
Google_Service_Directory_Channel

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.
string customer Immutable ID of the G Suite account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain.
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.
string event Event on which subscription is intended (if subscribing)
int maxResults Maximum number of results to return.
string orderBy Column to use for sorting results
string pageToken Token to specify next page in the list
string projection What subset of fields to fetch for this user.
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
string showDeleted If set to true, retrieves the list of deleted users. (Default: false)
string sortOrder Whether to return results in ascending or descending order.
string viewType Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.
© 2020 Google Inc.
Admin Directory API documentation generated by ApiGen 2.8.0