orgunits.update: Updates an organizational unit.

Description Usage Arguments Details See Also

View source: R/orgunits.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
orgunits.update(
  customerId,
  orgUnitPath,
  name = NULL,
  description = NULL,
  blockInheritance = NULL,
  parentOrgUnitId = NULL,
  kind = NULL,
  orgUnitId = NULL,
  parentOrgUnitPath = NULL,
  etag = NULL,
  callback = NULL,
  fields = NULL,
  uploadType = NULL,
  upload_protocol = NULL,
  prettyPrint = NULL,
  quotaUser = NULL,
  alt = NULL,
  gargle_token = gargle::token_fetch(scopes =
    .endpoints[["directory.orgunits.update"]]$scopes[[1]]),
  return_request = F,
  return_response = F
)

Arguments

customerId

The unique ID for the customer's Google Workspace account. 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 resource.

orgUnitPath

The full path of the organizational unit or its unique ID.

name

The organizational unit's path name. For example, an organizational unit's name within the /corp/support/sales_support parent path is sales_support. Required.

description

Description of the organizational unit.

blockInheritance

Determines if a sub-organizational unit can inherit the settings of the parent organization. The default value is false, meaning a sub-organizational unit inherits the settings of the nearest parent organizational unit. For more information on inheritance and users in an organization structure, see the administration help center.

parentOrgUnitId

The unique ID of the parent organizational unit. Required, unless parentOrgUnitPath is set.

kind

The type of the API resource. For Orgunits resources, the value is admin#directory#orgUnit.

orgUnitId

The unique ID of the organizational unit.

parentOrgUnitPath

The organizational unit's parent path. For example, /corp/sales is the parent path for /corp/sales/sales_support organizational unit. Required, unless parentOrgUnitId is set.

etag

ETag of the resource.

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.