users.list: Retrieves a paginated list of either deleted users or all...

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
users.list(
  pageToken = NULL,
  customFieldMask = NULL,
  event = NULL,
  sortOrder = NULL,
  viewType = NULL,
  query = NULL,
  domain = NULL,
  showDeleted = NULL,
  orderBy = NULL,
  maxResults = NULL,
  customer = NULL,
  projection = 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.list"]]$scopes[[1]]),
  return_request = F,
  return_response = F
)

Arguments

pageToken

Token to specify next page in the list

customFieldMask

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

event

Event on which subscription is intended (if subscribing)

sortOrder

Whether to return results in ascending or descending order.

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.

query

Query string for searching user fields. For more information on constructing user queries, see Search for Users.

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. Either the customer or the domain parameter must be provided.

showDeleted

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

orderBy

Property to use for sorting results.

maxResults

Maximum number of results to return.

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. You can also use the my_customer alias to represent your account's customerId. The customerId is also returned as part of the Users resource. Either the customer or the domain parameter must be provided.

projection

What subset of fields to fetch for this user.

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.