Method: members.patch
Stay organized with collections
Save and categorize content based on your preferences.
Updates the membership properties of a user in the specified group. This method supports patch semantics.
HTTP request
PATCH https://admin.googleapis.com/admin/directory/v1/groups/{groupKey}/members/{memberKey}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters |
groupKey |
string
Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.
|
memberKey |
string
Identifies the group member in the API request. A group member can be a user or another group. The value can be the member's (group or user) primary email address, alias, or unique ID.
|
Request body
The request body contains an instance of Member
.
Response body
If successful, the response body contains an instance of Member
.
Authorization scopes
Requires one of the following OAuth scopes:
https://apps-apis.google.com/a/feeds/groups/
https://www.googleapis.com/auth/admin.directory.group
https://www.googleapis.com/auth/admin.directory.group.member
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 2025-03-25 UTC.
[null,null,["Last updated 2025-03-25 UTC."],[],[],null,["# Method: members.patch\n\nUpdates the membership properties of a user in the specified group. This method supports [patch semantics](https://developers.google.com/workspace/admin/directory/v1/guides/performance#patch).\n\n### HTTP request\n\n`PATCH https://admin.googleapis.com/admin/directory/v1/groups/{groupKey}/members/{memberKey}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `groupKey` | `string` Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID. |\n| `memberKey` | `string` Identifies the group member in the API request. A group member can be a user or another group. The value can be the member's (group or user) primary email address, alias, or unique ID. |\n\n### Request body\n\nThe request body contains an instance of [Member](/workspace/admin/directory/reference/rest/v1/members#Member).\n\n### Response body\n\nIf successful, the response body contains an instance of [Member](/workspace/admin/directory/reference/rest/v1/members#Member).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://apps-apis.google.com/a/feeds/groups/`\n- `\n https://www.googleapis.com/auth/admin.directory.group`\n- `\n https://www.googleapis.com/auth/admin.directory.group.member`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]