1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Directory
  7. \
  8. Resource
  9. \
  10. Groups

Groups

class Groups extends Resource (View source)

The "groups" collection of methods.

Typical usage is:

 $adminService = new Google\Service\Directory(...);
 $groups = $adminService->groups;

Methods

delete(string $groupKey, array $optParams = [])

Deletes a group. (groups.delete)

Group
get(string $groupKey, array $optParams = [])

Retrieves a group's properties. (groups.get)

Group
insert(Group $postBody, array $optParams = [])

Creates a group. (groups.insert)

Groups
listGroups(array $optParams = [])

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

Group
patch(string $groupKey, Group $postBody, array $optParams = [])

Updates a group's properties. This method supports patch semantics. (groups.patch)

Group
update(string $groupKey, Group $postBody, array $optParams = [])

Updates a group's properties. (groups.update)

Details

at line 41
delete(string $groupKey, array $optParams = [])

Deletes a group. (groups.delete)

Parameters

string $groupKey

Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.
array $optParams

Optional parameters.

Exceptions

Exception

at line 56
Group get(string $groupKey, array $optParams = [])

Retrieves a group's properties. (groups.get)

Parameters

string $groupKey

Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.
array $optParams

Optional parameters.

Return Value

Group

Exceptions

Exception

at line 70
Group insert(Group $postBody, array $optParams = [])

Creates a group. (groups.insert)

Parameters

Group $postBody
array $optParams

Optional parameters.

Return Value

Group

Exceptions

Exception

at line 107
Groups listGroups(array $optParams = [])

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

(groups.listGroups)

Parameters

array $optParams

Optional parameters.

Return Value

Groups

Exceptions

Exception

at line 124
Group patch(string $groupKey, Group $postBody, array $optParams = [])

Updates a group's properties. This method supports patch semantics. (groups.patch)

Parameters

string $groupKey

Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.
Group $postBody
array $optParams

Optional parameters.

Return Value

Group

Exceptions

Exception

at line 140
Group update(string $groupKey, Group $postBody, array $optParams = [])

Updates a group's properties. (groups.update)

Parameters

string $groupKey

Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.
Group $postBody
array $optParams

Optional parameters.

Return Value

Group

Exceptions

Exception