Method: users.patch

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 method instead of the patch method.

HTTP request

PATCH 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.