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_Groups_Resource

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

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

Delete Group (groups.delete)

Delete Group (groups.delete)

Parameters

$groupKey
Email or immutable ID of the group
$optParams
Optional parameters.
public Google_Service_Directory_Group
# get( string $groupKey, array $optParams = array() )

Retrieve Group (groups.get)

Retrieve Group (groups.get)

Parameters

$groupKey
Email or immutable ID of the group
$optParams
Optional parameters.

Returns

Google_Service_Directory_Group
Google_Service_Directory_Group
public Google_Service_Directory_Group
# insert( Google_Service_Directory_Group $postBody, array $optParams = array() )

Create Group (groups.insert)

Create Group (groups.insert)

Parameters

$postBody
$optParams
Optional parameters.

Returns

Google_Service_Directory_Group
Google_Service_Directory_Group
public Google_Service_Directory_Groups
# listGroups( array $optParams = array() )

Retrieve all groups of a domain or of a user given a userKey (paginated) (groups.listGroups)

Retrieve all groups of a domain or of a user given a userKey (paginated) (groups.listGroups)

Parameters

$optParams
Optional parameters.

Returns

Google_Service_Directory_Groups
Google_Service_Directory_Groups

Opt_param

string customer Immutable ID of the G Suite account. In case of multi-domain, to fetch all groups for a customer, fill this field instead of domain.
string domain Name of the domain. Fill this field to get groups from only this domain. To return all groups in a multi-domain fill customer field instead.
int maxResults Maximum number of results to return. Max allowed value is 200.
string orderBy Column to use for sorting results
string pageToken Token to specify next page in the list
string query Query string search. Should be of the form "". Complete documentation is at https://developers.google.com/admin- sdk/directory/v1/guides/search-groups
string sortOrder Whether to return results in ascending or descending order. Only of use when orderBy is also used
string userKey Email or immutable ID of the user if only those groups are to be listed, the given user is a member of. If it's an ID, it should match with the ID of the user object.
public Google_Service_Directory_Group
# patch( string $groupKey, Google_Service_Directory_Group $postBody, array $optParams = array() )

Update Group. This method supports patch semantics. (groups.patch)

Update Group. This method supports patch semantics. (groups.patch)

Parameters

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

Returns

Google_Service_Directory_Group
Google_Service_Directory_Group
public Google_Service_Directory_Group
# update( string $groupKey, Google_Service_Directory_Group $postBody, array $optParams = array() )

Update Group (groups.update)

Update Group (groups.update)

Parameters

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

Returns

Google_Service_Directory_Group
Google_Service_Directory_Group
© 2020 Google Inc.
Admin Directory API documentation generated by ApiGen 2.8.0