patch method
Updates a user using patch semantics.
The update method should be used instead, because it also supports patch
semantics and has better performance. If you're mapping an external
identity to a Google identity, use the
[update
](https://developers.google.com/admin-sdk/directory/v1/reference/users/update)
method instead of the patch
method. This method is unable to clear
fields that contain repeated objects (addresses
, phones
, etc). Use the
update method instead.
request
- The metadata request object.
Request parameters:
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.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a User.
Completes with a commons.ApiRequestError if the API endpoint returned an error.
If the used http.Client
completes with an error when making a REST call,
this method will complete with the same error.
Implementation
async.Future<User> patch(
User request,
core.String userKey, {
core.String? $fields,
}) async {
final body_ = convert.json.encode(request);
final queryParams_ = <core.String, core.List<core.String>>{
if ($fields != null) 'fields': [$fields],
};
final url_ =
'admin/directory/v1/users/' + commons.escapeVariable('$userKey');
final response_ = await _requester.request(
url_,
'PATCH',
body: body_,
queryParams: queryParams_,
);
return User.fromJson(response_ as core.Map<core.String, core.dynamic>);
}