users.watch: Watches for changes in users list.

Description Usage Arguments Details See Also

View source: R/users.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
22
23
24
25
26
27
28
29
30
31
32
33
34
35
users.watch(
  projection = NULL,
  orderBy = NULL,
  customFieldMask = NULL,
  viewType = NULL,
  domain = NULL,
  customer = NULL,
  maxResults = NULL,
  showDeleted = NULL,
  event = NULL,
  pageToken = NULL,
  query = NULL,
  sortOrder = NULL,
  params = NULL,
  expiration = NULL,
  payload = NULL,
  type = NULL,
  kind = NULL,
  address = NULL,
  resourceUri = NULL,
  token = NULL,
  id = NULL,
  resourceId = NULL,
  callback = NULL,
  fields = NULL,
  uploadType = NULL,
  upload_protocol = NULL,
  prettyPrint = NULL,
  quotaUser = NULL,
  alt = NULL,
  gargle_token = gargle::token_fetch(scopes =
    .endpoints[["directory.users.watch"]]$scopes[[1]]),
  return_request = F,
  return_response = F
)

Arguments

projection

What subset of fields to fetch for this user.

orderBy

Column to use for sorting results

customFieldMask

Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.

viewType

Whether to fetch the administrator-only or domain-wide public view of the user. For more information, see Retrieve a user as a non-administrator.

domain

Name of the domain. Fill this field to get users from only this domain. To return all users in a multi-domain fill customer field instead."

customer

Immutable ID of the Google Workspace account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain.

maxResults

Maximum number of results to return.

showDeleted

If set to true, retrieves the list of deleted users. (Default: false)

event

Events to watch for.

pageToken

Token to specify next page in the list

query

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

sortOrder

Whether to return results in ascending or descending order.

params

Additional parameters controlling delivery channel behavior. Optional.

expiration

Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.

payload

A Boolean value to indicate whether payload is wanted. Optional.

type

The type of delivery mechanism used for this channel.

kind

Identifies this as a notification channel used to watch for changes to a resource, which is api#channel.

address

The address where notifications are delivered for this channel.

resourceUri

A version-specific identifier for the watched resource.

token

An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.

id

A UUID or similar unique string that identifies this channel.

resourceId

An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.

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.