groups.patch: Updates a group's properties.

Description Usage Arguments Details See Also

View source: R/groups.R

Description

This method supports patch semantics. 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
22
23
24
groups.patch(
  groupKey,
  description = NULL,
  nonEditableAliases = NULL,
  name = NULL,
  kind = NULL,
  aliases = NULL,
  directMembersCount = NULL,
  email = NULL,
  etag = NULL,
  adminCreated = NULL,
  id = 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.patch"]]$scopes[[1]]),
  return_request = F,
  return_response = F
)

Arguments

groupKey

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

description

An extended description to help users determine the purpose of a group. For example, you can include information about who should join the group, the types of messages to send to the group, links to FAQs about the group, or related groups. Maximum length is 4,096 characters.

nonEditableAliases

List of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group. This is a read-only property returned in the API's response for a group. If edited in a group's POST or PUT request, the edit is ignored by the API service.

name

The group's display name.

kind

The type of the API resource. For Groups resources, the value is admin#directory#group.

aliases

List of a group's alias email addresses.

directMembersCount

The number of users that are direct members of the group. If a group is a member (child) of this group (the parent), members of the child group are not counted in the directMembersCount property of the parent group.

email

The group's email address. If your account has multiple domains, select the appropriate domain for the email address. The email must be unique. This property is required when creating a group. Group email addresses are subject to the same character usage rules as usernames, see the help center for details.

etag

ETag of the resource.

adminCreated

Value is true if this group was created by an administrator rather than a user.

id

The unique ID of a group. A group id can be used as a group request URI's groupKey.

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.