Requires authorization
Updates the membership of a user in the specified group. Try it now.
Request
HTTP request
PUT https://www.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey
Parameters
Parameter name | Value | Description |
---|---|---|
Path 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. |
Authorization
This request requires authorization with at least one of the following scopes (read more about authentication and authorization).
Scope |
---|
https://www.googleapis.com/auth/admin.directory.group.member |
https://www.googleapis.com/auth/admin.directory.group |
Request body
In the request body, supply a Members resource with the following properties:
Property name | Value | Description | Notes |
---|---|---|---|
Optional Properties | |||
delivery_settings |
string |
Defines mail delivery preferences of member. This is only supported by create/update/get.
Acceptable values are:
|
writable |
role |
string |
The member's role in a group. The API returns an error for cycles in group memberships. For example, if group1 is a member of group2 , group2 cannot be a member of group1 . For more information about a member's role, see the administration help center.
Acceptable values are:
|
writable |
Response
If successful, this method returns a Members resource in the response body.
Try it!
Use the APIs Explorer below to call this method on live data and see the response.