groups.list: Retrieves all groups of a domain or of a user given a userKey...

Description Usage Arguments Details See Also

View source: R/groups.R

Description

Autogenerated via package_make.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
groups.list(
  orderBy = NULL,
  domain = NULL,
  userKey = NULL,
  customer = NULL,
  maxResults = NULL,
  query = NULL,
  pageToken = NULL,
  sortOrder = NULL,
  callback = NULL,
  fields = NULL,
  uploadType = NULL,
  upload_protocol = NULL,
  prettyPrint = NULL,
  quotaUser = NULL,
  alt = NULL,
  gargle_token = gargle::token_fetch(scopes =
    .endpoints[["directory.groups.list"]]$scopes[[1]]),
  return_request = F,
  return_response = F
)

Arguments

orderBy

Column to use for sorting results

domain

The domain name. Use this field to get fields from only one domain. To return all domains for a customer account, use the customer query parameter instead.

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.

customer

The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, fill this field instead of domain. As an account administrator, you can also use the my_customer alias to represent your account's customerId. The customerId is also returned as part of the Users

maxResults

Maximum number of results to return. Max allowed value is 200.

query

Query string search. Should be of the form "". Complete documentation is at https: //developers.google.com/admin-sdk/directory/v1/guides/search-groups

pageToken

Token to specify next page in the list

sortOrder

Whether to return results in ascending or descending order. Only of use when orderBy is also used

callback

JSONP

fields

Selector specifying which fields to include in a partial response.

uploadType

Legacy upload protocol for media (e.g. "media", "multipart").

upload_protocol

Upload protocol for media (e.g. "raw", "multipart").

prettyPrint

Returns response with indentations and line breaks.

quotaUser

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

alt

Data format for response.

gargle_token

A token prepared by one of gargle's token generating functions. Defaults to gargle::token_fetch(...) with appropriate scopes. See token_fetch for more info.

return_request

Whether to return the request without making it. Defaults to FALSE. See request_build for more info on the returned request object.

return_response

Whether to return the response or the response content. Defaults to FALSE (return response content).

Details

Authentication scopes used by this function are:

See Also

Google Documentation


samterfa/gapiAdminSDK documentation built on Dec. 22, 2021, 10:11 p.m.