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

Groups

class Groups extends Resource (View source)

The "groups" collection of methods.

Typical usage is:

 $cloudidentityService = new Google\Service\CloudIdentity(...);
 $groups = $cloudidentityService->groups;

Methods

Operation
create(Group $postBody, array $optParams = [])

Creates a Group. (groups.create)

Operation
delete(string $name, array $optParams = [])

Deletes a Group. (groups.delete)

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

Retrieves a Group. (groups.get)

SecuritySettings
getSecuritySettings(string $name, array $optParams = [])

Get Security Settings (groups.getSecuritySettings)

ListGroupsResponse
listGroups(array $optParams = [])

Lists the Group resources under a customer or namespace.

LookupGroupNameResponse
lookup(array $optParams = [])

Looks up the resource name of a Group by its EntityKey. (groups.lookup)

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

Updates a Group. (groups.patch)

SearchGroupsResponse
search(array $optParams = [])

Searches for Group resources matching a specified query. (groups.search)

Operation
updateSecuritySettings(string $name, SecuritySettings $postBody, array $optParams = [])

Update Security Settings (groups.updateSecuritySettings)

Details

at line 48
Operation create(Group $postBody, array $optParams = [])

Creates a Group. (groups.create)

Parameters

Group $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 64
Operation delete(string $name, array $optParams = [])

Deletes a Group. (groups.delete)

Parameters

string $name

Required. The resource name of the Group to retrieve. Must be of the form groups/{group}.
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 80
Group get(string $name, array $optParams = [])

Retrieves a Group. (groups.get)

Parameters

string $name

Required. The resource name of the Group to retrieve. Must be of the form groups/{group}.
array $optParams

Optional parameters.

Return Value

Group

Exceptions

Exception

at line 99
SecuritySettings getSecuritySettings(string $name, array $optParams = [])

Get Security Settings (groups.getSecuritySettings)

Parameters

string $name

Required. The security settings to retrieve. Format: groups/{group_id}/securitySettings
array $optParams

Optional parameters.

Return Value

SecuritySettings

Exceptions

Exception

at line 131
ListGroupsResponse listGroups(array $optParams = [])

Lists the Group resources under a customer or namespace.

(groups.listGroups)

Parameters

array $optParams

Optional parameters.

Return Value

ListGroupsResponse

Exceptions

Exception

at line 159
LookupGroupNameResponse lookup(array $optParams = [])

Looks up the resource name of a Group by its EntityKey. (groups.lookup)

Parameters

array $optParams

Optional parameters.

Return Value

LookupGroupNameResponse

Exceptions

Exception

at line 180
Operation patch(string $name, Group $postBody, array $optParams = [])

Updates a Group. (groups.patch)

Parameters

string $name

Output only. The resource name of the Group. Shall be of the form groups/{group}.
Group $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Searches for Group resources matching a specified query. (groups.search)

Parameters

array $optParams

Optional parameters.

Return Value

SearchGroupsResponse

Exceptions

Exception

at line 239
Operation updateSecuritySettings(string $name, SecuritySettings $postBody, array $optParams = [])

Update Security Settings (groups.updateSecuritySettings)

Parameters

string $name

Output only. The resource name of the security settings. Shall be of the form groups/{group_id}/securitySettings.
SecuritySettings $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception