Method: users.update
Updates a user.
This method supports patch semantics, meaning that you only need to include the fields you wish to update. Fields that are not present in the request will be preserved, and fields set to null will be cleared.
For repeating fields that contain arrays, individual items in the array can't be patched piecemeal; they must be supplied in the request body with the desired values for all items. See the user accounts guide for more information.
HTTP request
PUT https://admin.googleapis.com/admin/directory/v1/users/{userKey}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
userKey |
string
Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.
|
Request body
The request body contains an instance of User.
Response body
If successful, the response body contains an instance of User.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/admin.directory.user
For more information, see the Authorization guide.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-08-22 UTC.
[null,null,["Last updated 2024-08-22 UTC."],[[["This method allows you to update user information by sending a PUT request to a specific URL, using the user's email address or ID."],["You only need to include the fields you want to change in the request; unchanged fields are preserved, while fields set to `null` are cleared."],["When updating repeating fields (arrays), you must provide the entire array with all desired values in the request body."],["Authorization requires the `https://www.googleapis.com/auth/admin.directory.user` OAuth scope."]]],["A user is updated via a `PUT` request to the specified URL, using the `userKey` (email or ID) to identify them. The request body includes the `User` instance, with only fields to be modified. Absent fields are preserved, `null` fields are cleared, and array fields must be fully replaced. Successful requests return the updated `User` instance. Authorization requires the `admin.directory.user` OAuth scope.\n"]]
