members.patch: Updates the membership properties of a user in the specified...

Description Usage Arguments Details See Also

View source: R/members.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
members.patch(
  memberKey,
  groupKey,
  etag = NULL,
  status = NULL,
  role = NULL,
  delivery_settings = NULL,
  type = NULL,
  id = NULL,
  email = NULL,
  kind = NULL,
  callback = NULL,
  fields = NULL,
  uploadType = NULL,
  upload_protocol = NULL,
  prettyPrint = NULL,
  quotaUser = NULL,
  alt = NULL,
  gargle_token = gargle::token_fetch(scopes =
    .endpoints[["directory.members.patch"]]$scopes[[1]]),
  return_request = F,
  return_response = F
)

Arguments

memberKey

Identifies the group member in the API request. A group member can be a user or another group. The value can be the member's (group or user) primary email address, alias, or unique ID.

groupKey

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

etag

ETag of the resource.

status

Status of member (Immutable)

role

The member's role in a group. The API returns an error for cycles in group memberships. For example, if group1 is a member of group2, group2 cannot be a member of group1. For more information about a member's role, see the administration help center.

delivery_settings

Defines mail delivery preferences of member. This is only supported by create/update/get.

type

The type of group member.

id

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

email

The member's email address. A member can be a user or another group. This property is required when adding a member to a group. The email must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.

kind

The type of the API resource. For Members resources, the value is admin#directory#member.

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.