users.patch: Updates a user using patch semantics.
In samterfa/gapiAdminSDK: Consume Google's Admin SDK API

Description Usage Arguments Details See Also

The update method should be used instead, since it also supports patch semantics and has better performance. This method is unable to clear fields that contain repeated objects (addresses, phones, etc). Use the update method instead. Autogenerated via package_make.

users.patch(
  userKey,
  name = NULL,
  phones = NULL,
  id = NULL,
  customSchemas = NULL,
  organizations = NULL,
  locations = NULL,
  ipWhitelisted = NULL,
  includeInGlobalAddressList = NULL,
  gender = NULL,
  hashFunction = NULL,
  posixAccounts = NULL,
  externalIds = NULL,
  keywords = NULL,
  ims = NULL,
  notes = NULL,
  addresses = NULL,
  changePasswordAtNextLogin = NULL,
  recoveryEmail = NULL,
  password = NULL,
  sshPublicKeys = NULL,
  archived = NULL,
  languages = NULL,
  suspended = NULL,
  primaryEmail = NULL,
  emails = NULL,
  recoveryPhone = NULL,
  orgUnitPath = NULL,
  relations = NULL,
  websites = 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.patch"]]$scopes[[1]]),
  return_request = F,
  return_response = F
)

`userKey`	Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.
`name`	Holds the given and family names of the user, and the read-only `fullName` value. The maximum number of characters in the `givenName` and in the `familyName` values is 60. In addition, name values support unicode/UTF-8 characters, and can contain spaces, letters (a-z), numbers (0-9), dashes (-), forward slashes (/), and periods (.). For more information about character usage rules, see the administration help center. Maximum allowed data size for this field is 1Kb.
`phones`	A list of the user's phone numbers. The maximum allowed data size for this field is 1Kb.
`id`	The unique ID for the user. A user `id` can be used as a user request URI's `userKey`.
`customSchemas`	Custom fields of the user.
`organizations`	A list of organizations the user belongs to. The maximum allowed data size for this field is 10Kb.
`locations`	The user's locations. The maximum allowed data size for this field is 10Kb.
`ipWhitelisted`	If `true`, the user's IP address is whitelisted.
`includeInGlobalAddressList`	Indicates if the user's profile is visible in the Google Workspace global address list when the contact sharing feature is enabled for the domain. For more information about excluding user profiles, see the administration help center.
`gender`	The user's gender. The maximum allowed data size for this field is 1Kb.
`hashFunction`	Stores the hash format of the password property. We recommend sending the `password` property value as a base 16 bit hexadecimal-encoded hash value. Set the `hashFunction` values as either the SHA-1, MD5, or crypt hash format.
`posixAccounts`	A list of POSIX account information for the user.
`externalIds`	A list of external IDs for the user, such as an employee or network ID. The maximum allowed data size for this field is 2Kb.
`keywords`	The user's keywords. The maximum allowed data size for this field is 1Kb.
`ims`	The user's Instant Messenger (IM) accounts. A user account can have multiple ims properties. But, only one of these ims properties can be the primary IM contact. The maximum allowed data size for this field is 2Kb.
`notes`	Notes for the user.
`addresses`	A list of the user's addresses. The maximum allowed data size for this field is 10Kb.
`changePasswordAtNextLogin`	Indicates if the user is forced to change their password at next login. This setting doesn't apply when the user signs in via a third-party identity provider.
`recoveryEmail`	Recovery email of the user.
`password`	User's password
`sshPublicKeys`	A list of SSH public keys.
`archived`	Indicates if user is archived.
`languages`	The user's languages. The maximum allowed data size for this field is 1Kb.
`suspended`	Indicates if user is suspended.
`primaryEmail`	The user's primary email address. This property is required in a request to create a user account. The `primaryEmail` must be unique and cannot be an alias of another user.
`emails`	A list of the user's email addresses. The maximum allowed data size for this field is 10Kb.
`recoveryPhone`	Recovery phone of the user. The phone number must be in the E.164 format, starting with the plus sign (+). Example: +16506661212.
`orgUnitPath`	The full path of the parent organization associated with the user. If the parent organization is the top-level, it is represented as a forward slash (`/`).
`relations`	A list of the user's relationships to other users. The maximum allowed data size for this field is 2Kb.
`websites`	The user's websites. The maximum allowed data size for this field is 2Kb.
`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).