Method: users.update

Stay organized with collections Save and categorize content based on your preferences.

Updates a user.

This method supports patch semantics, meaning 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.

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 OAuth 2.0 Overview.