Documentation

Google_Service_CloudIdentity_Resource_Groups extends Google_Service_Resource
in package

The "groups" collection of methods.

Typical usage is: $cloudidentityService = new Google_Service_CloudIdentity(...); $groups = $cloudidentityService->groups;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
create()  : Google_Service_CloudIdentity_Operation
Creates a Group. (groups.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_CloudIdentity_Operation
Deletes a `Group`. (groups.delete)
get()  : Google_Service_CloudIdentity_Group
Retrieves a `Group`. (groups.get)
listGroups()  : Google_Service_CloudIdentity_ListGroupsResponse
Lists the `Group`s under a customer or namespace. (groups.listGroups)
lookup()  : Google_Service_CloudIdentity_LookupGroupNameResponse
Looks up the [resource name](https://cloud.google.com/apis/design/resource_names) of a `Group` by its `EntityKey`. (groups.lookup)
patch()  : Google_Service_CloudIdentity_Operation
Updates a `Group`. (groups.patch)
search()  : Google_Service_CloudIdentity_SearchGroupsResponse
Searches for `Group`s matching a specified query. (groups.search)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

listGroups()

Lists the `Group`s under a customer or namespace. (groups.listGroups)

public listGroups([array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudIdentity_ListGroupsResponse
Parameters
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string pageToken The next_page_token value returned from a previous list request, if any.

opt_param

string view The level of detail to be returned. If unspecified, defaults to View.BASIC.

opt_param

string parent Required. The parent resource under which to list all Groups. Must be of the form identitysources/{identity_source_id} for external- identity-mapped groups or customers/{customer_id} for Google Groups.

opt_param

int pageSize The maximum number of results to return. Note that the number of results returned may be less than this value even if there are more available results. To fetch all results, clients must continue calling this method repeatedly until the response no longer contains a next_page_token. If unspecified, defaults to 200 for View.BASIC and to 50 for View.FULL. Must not be greater than 1000 for View.BASIC or 500 for View.FULL.

Return values
Google_Service_CloudIdentity_ListGroupsResponse —

lookup()

Looks up the [resource name](https://cloud.google.com/apis/design/resource_names) of a `Group` by its `EntityKey`. (groups.lookup)

public lookup([array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudIdentity_LookupGroupNameResponse
Parameters
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string groupKey.namespace The namespace in which the entity exists. If not specified, the EntityKey represents a Google-managed entity such as a Google user or a Google Group. If specified, the EntityKey represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of `identitysources/{identity_source_id}.

opt_param

string groupKey.id The ID of the entity. For Google-managed entities, the id should be the email address of an existing group or user. For external-identity-mapped entities, the id must be a string conforming to the Identity Source's requirements. Must be unique within a namespace.

Return values
Google_Service_CloudIdentity_LookupGroupNameResponse —

patch()

Updates a `Group`. (groups.patch)

public patch(string $name, Google_Service_CloudIdentity_Group $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudIdentity_Operation
Parameters
$name : string

Output only. The resource name of the Group. Shall be of the form groups/{group_id}.

$postBody : Google_Service_CloudIdentity_Group
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string updateMask Required. The fully-qualified names of fields to update. May only contain the following fields: display_name, description.

Return values
Google_Service_CloudIdentity_Operation —

search()

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

public search([array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudIdentity_SearchGroupsResponse
Parameters
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string pageToken The next_page_token value returned from a previous search request, if any.

opt_param

string view The level of detail to be returned. If unspecified, defaults to View.BASIC.

opt_param

int pageSize The maximum number of results to return. Note that the number of results returned may be less than this value even if there are more available results. To fetch all results, clients must continue calling this method repeatedly until the response no longer contains a next_page_token. If unspecified, defaults to 200 for GroupView.BASIC and 50 for GroupView.FULL. Must not be greater than 1000 for GroupView.BASIC or 500 for GroupView.FULL.

opt_param

string query Required. The search query. Must be specified in Common Expression Language. May only contain equality operators on the parent and inclusion operators on labels (e.g., parent == 'customers/{customer_id}' && 'cloudidentity.googleapis.com/groups.discussion_forum' in labels).

Return values
Google_Service_CloudIdentity_SearchGroupsResponse —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results