Directory API: グループ メンバー
コレクションでコンテンツを整理
必要に応じて、コンテンツの保存と分類を行います。
グループにメンバーを追加する
グループにメンバーを追加するには、次の POST リクエストを使用し、その際にはリクエストを承認するで説明されている承認を含めます。グループ メンバーには、ユーザーまたは別のグループを指定できます。groupKey は、新しいメンバーのグループ メールアドレスまたはグループの一意の id です。リクエストとレスポンスのプロパティについては、API リファレンスをご覧ください。
POST https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members
グループを別のグループのメンバーとして追加する場合、子グループのメンバーが親グループのメンバーに現れるまでに 10 分ほどかかることがあります。また、グループ メンバーシップが循環している場合にもエラーが返されます。たとえば、group1 が group2 のメンバーの場合、group2 を group1 のメンバーにすることはできません。
JSON リクエスト
次の JSON リクエストは、グループ メンバーを作成するリクエスト本文のサンプルです。メンバーのメールアドレスは liz@example.com で、グループのメンバーのロールは MEMBER です。この POST リクエストでは、groupKey に NNNNN を使用しています。
POST https://admin.googleapis.com/admin/directory/v1/groups/NNNNN/members
{
"email": "liz@example.com",
"role": "MEMBER"
}
グループ メンバーの role には、以下の値を指定できます。
OWNER - このロールでは、グループへの送信メッセージの変更、メンバーの追加と削除、メンバーロールの変更、グループの設定の変更、グループの削除を行えます。OWNER はグループのメンバーである必要があります。MANAGER - このロールを使用できるのは、管理コンソールで Google Workspace を有効した場合のみです。MANAGER ロールでは、メンバーを OWNER ロールにするか、グループを削除する以外の OWNER ロールで実行できるすべての操作を行えます。グループには複数の OWNER メンバーと MANAGER メンバーを含めることができます。
MEMBER - このロールは、グループへの登録、ディスカッション アーカイブの表示、グループのメンバーシップ リストの表示を行うことができます。メンバーのロールの詳細については、管理者向けヘルプセンターをご覧ください。
JSON レスポンス
成功すると、HTTP 200 ステータス コードとメンバーシップ情報が返されます。id はメンバーの一意のメンバーシップ ID です。
{
"kind": "directory#member",
"id": "group member's unique ID",
"email": "liz@example.com",
"role": "MEMBER",
"type": "GROUP"
}
グループ メンバーの type には、以下の値を指定できます。
GROUP – メンバーは別のグループMEMBER – メンバーはユーザー
グループ メンバーシップを更新する
グループ メンバーシップを更新するには、次の PUT リクエストを使用し、その際にはリクエストを承認するで説明されている承認を含めます。groupKey は、グループのメールアドレスまたはグループの一意の id です。memberKey は、ユーザーまたはグループのメインのメールアドレス、ユーザーのエイリアスのメールアドレス、またはユーザーの一意の id です。リクエストとレスポンスのプロパティについては、API リファレンスをご覧ください。
PUT https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey
JSON リクエスト
次の JSON リクエストは、グループ メンバーシップ設定を更新するリクエスト本文の例です。メンバーのメールアドレスは liz@example.com で、グループのメンバーのロールは MEMBER から MANAGER に変更されています。この例の PUT リクエストの groupKey は NNNNN です。MEMBER、OWNER、MANAGER のロールの詳細については、管理者向けヘルプセンターをご覧ください。
PUT https://admin.googleapis.com/admin/directory/v1/groups/NNNNN/members/liz@example.com
{
"email": "liz@example.com",
"role": "MANAGER"
}
JSON レスポンス
成功すると、HTTP 200 ステータス コードと更新されたメンバーシップ情報が返されます。id はメンバーの一意のメンバーシップ ID です。
{
"kind": "directory#member",
"id": "group member's unique ID",
"email": "liz@example.com",
"role": "MANAGER",
"type": "GROUP"
}
グループのメンバーを取得する
グループ メンバーシップを取得するには、次の GET リクエストを使用し、その際にはリクエストを承認するで説明されている承認を含めます。groupKey は、グループのメールアドレスまたはグループの一意の id です。memberKey は、ユーザーまたはグループのメインのメールアドレス、ユーザーのエイリアスのメールアドレス、またはユーザーの一意の id です。リクエストとレスポンスのプロパティについては、API リファレンスをご覧ください。
GET https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey
JSON レスポンス
成功すると、HTTP 200 ステータス コードとメンバーシップ情報が返されます。id はメンバーの一意のメンバーシップ ID です。
{
"kind": "directory#member",
"id": "group member's unique ID",
"email": "liz@example.com",
"role": "MANAGER",
"type": "GROUP"
}
すべてのグループ メンバーを取得する
すべてのグループ メンバーを取得するには、次の GET リクエストを使用し、その際にはリクエストを承認するで説明されている承認を含めます。groupKey は、グループ メールアドレスまたはグループの一意の id です。オプションの roles クエリ文字列は、グループロールをロールごとに取得できるフィルタです。結果のロールのコレクションは roles フィルタで指定した順序になります。リクエストとレスポンスのプロパティについては、API リファレンスをご覧ください。この例では、読みやすくするために改行を使用しています。
GET https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members
?pageToken=pagination token
&roles=one or more of OWNER,MANAGER,MEMBER separated by a comma
&maxResults=maximum results per response page
すべてのメンバーが、メンバーのメールアドレスのアルファベット順で返されます。また、多数のメンバーを含むレスポンスには pageToken クエリ文字列を使用します。ページ分けの場合、レスポンスは次のページのトークンを含む nextPageToken プロパティを返します。次のリクエストでは、このトークンを pageToken クエリ文字列値として使用します。
JSON レスポンス
成功すると、HTTP 200 ステータス コードとメンバー情報のリストが返されます。id はメンバーの一意のメンバーシップ ID です。このレスポンスには、後続のグループ メンバー リストの nextPageToken があります。
{
"kind": "directory#members",
"members": [
{
"kind": "directory#member",
"id": "group member's unique ID",
"email": "liz@example.com",
"role": "MANAGER",
"type": "USER"
},
{
"kind": "directory#member",
"id": "group member's unique ID",
"email": "radhe@example.com",
"role": "MANAGER",
"type": "USER"
}
],
"nextPageToken": "NNNNN"
}
グループのメンバーシップを削除する
グループのメンバーのメンバーシップを削除するには、次の DELETE リクエストを使用し、その際にはリクエストを承認するで説明されている承認を含めます。groupKey は、グループの一意の id です。memberKey は、削除されたユーザーまたはグループ メンバーのメインのメールアドレス、あるいはユーザーの一意の id です。リクエストとレスポンスのプロパティについては、API リファレンスをご覧ください。
DELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey
たとえば、次の DELETE リクエストでは、groupKey が nnn で、memberKey がユーザーのメインのメールアドレス liz@example.com であるメンバーを削除します。DELETE https://admin.googleapis.com/admin/directory/v1/groups/nnnn/members/liz@example.com
成功すると、レスポンスとして HTTP 200 のステータス コードが返されます。
メンバーを削除した場合には、以下の点に注意してください。
- 削除したメンバーは、それ以降グループ宛のメールを受信できなくなります。
- グループからメンバーを削除しても、ユーザーのアカウントは削除されません。
- グループ オーナーを削除しても、グループは通常どおり機能します。管理者は、このグループを管理することも、別のグループ メンバーにオーナー権限を割り当てることもできます。
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2025-08-29 UTC。
[null,null,["最終更新日 2025-08-29 UTC。"],[],[],null,["# Directory API: Group Members\n\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| 1. [Add a member to a group](#create_member) 2. [Update a group membership](#update_member) 3. [Retrieve a group's member](#get_member) 4. [Retrieve all group members](#get_all_members) 5. [Delete membership in a group](#delete_member) |\n\nAdd a member to a group\n-----------------------\n\nTo add a member to a group, use the following `POST` request and include the authorization described in [Authorize requests](/workspace/admin/directory/v1/guides/authorizing). A group member can be a user or another group. The `groupKey` is the new member's group email address or the group's unique `id`. For the request and response properties, see the [API Reference](/workspace/admin/directory/v1/reference/members/insert): \n\n```\nPOST https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members\n```\n\nIf you add a group as a member of another group, there may be a delay of up to 10 minutes before the child group's members appear as members of the parent group. In addtion, 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.\n\n### JSON request\n\nThe following JSON request shows a sample request body that creates a group member. The member's email address is liz@example.com and the member's role in the group is as a `MEMBER`. The `POST` request uses NNNNN for the `groupKey`: \n\n```\nPOST https://admin.googleapis.com/admin/directory/v1/groups/NNNNN/members\n``` \n\n```transact-sql\n{\n \"email\": \"liz@example.com\",\n \"role\": \"MEMBER\"\n}\n```\n\nA group member's `role` can be:\n\n- `OWNER` -- This role can change send messages to the group, add or remove members, change member roles, change group's settings, and delete the group. An `OWNER` must be a member of the group.\n- `MANAGER` -- This role is only available if the Google Workspace is enabled using the Admin console. A MANAGER role can do everything done by an OWNER role except make a member an OWNER or delete the group. A group can have multiple OWNER and MANAGER members.\n- `MEMBER` -- This role can subscribe to a group, view discussion archives, and view the group's membership list. For more information about member roles, see the [administration help center](http://support.google.com/a/bin/answer.py?answer=167094).\n\n\u003cbr /\u003e\n\n### JSON response\n\nA successful response returns an [HTTP 200 status code](http://wikipedia.org/wiki/List_of_HTTP_status_codes) and the member's membership information. The `id` is the member's unique membership ID: \n\n```carbon\n{\n \"kind\": \"directory#member\",\n \"id\": \"group member's unique ID\",\n \"email\": \"liz@example.com\",\n \"role\": \"MEMBER\",\n \"type\": \"GROUP\"\n }\n```\n\nA group member's `type` can be:\n\n- `GROUP` -- The member is another group.\n- `MEMBER` -- The member is a user\n\n\u003cbr /\u003e\n\nUpdate a group membership\n-------------------------\n\nTo update a group membership, use the following `PUT` request and include the authorization described in [Authorize requests](/workspace/admin/directory/v1/guides/authorizing). The `groupKey` is the group's email address or the group's unique `id`, and the `memberKey` is the user's or group's primary email address, a user's alias email address, or the user's unique `id`. For the request and response properties, see the [API Reference](/workspace/admin/directory/v1/reference/members/update): \n\n```\nPUT https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey\n```\n| **Note:** The API also supports the [patch semantics](/workspace/admin/directory/v1/guides/performance#patch).\n\n### JSON request\n\nThe following JSON request shows a sample request body that updates a group membership settings. The member's email address is liz@example.com and the member's role in the group is changed from a `MEMBER` to a `MANAGER`. The `PUT` request's `groupKey` in this example is NNNNN. For information about the MEMBER, OWNER and MANAGER roles, see the [administration help center](http://support.google.com/a/bin/answer.py?answer=167094): \n\n```\nPUT https://admin.googleapis.com/admin/directory/v1/groups/NNNNN/members/liz@example.com\n``` \n\n```transact-sql\n{\n \"email\": \"liz@example.com\",\n \"role\": \"MANAGER\"\n}\n```\n\n### JSON response\n\nA successful response returns an [HTTP 200 status code](http://wikipedia.org/wiki/List_of_HTTP_status_codes) and the updated membership information. The `id` is the member's unique membership ID: \n\n```carbon\n{\n \"kind\": \"directory#member\",\n \"id\": \"group member's unique ID\",\n \"email\": \"liz@example.com\",\n \"role\": \"MANAGER\",\n \"type\": \"GROUP\"\n }\n```\n\nRetrieve a group's member\n-------------------------\n\nTo retrieve a group membership, use the following `GET` request and include the authorization described in [Authorize requests](/workspace/admin/directory/v1/guides/authorizing). The `groupKey` is the group's email address or the group's unique `id`, and the `memberKey` is the user's or group's primary email address, a user's alias email address, or the user's unique `id`. For the request and response properties, see the [API Reference](/workspace/admin/directory/v1/reference/members/get): \n\n```\nGET https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey\n```\n\n### JSON response\n\nA successful response returns an [HTTP 200 status code](http://wikipedia.org/wiki/List_of_HTTP_status_codes) and the member's membership information. The `id` is the member's unique membership ID: \n\n```carbon\n{\n \"kind\": \"directory#member\",\n \"id\": \"group member's unique ID\",\n \"email\": \"liz@example.com\",\n \"role\": \"MANAGER\",\n \"type\": \"GROUP\"\n }\n```\n\nRetrieve all group members\n--------------------------\n\nTo retrieve all group members, use the following `GET` request and include the authorization described in [Authorize requests](/workspace/admin/directory/v1/guides/authorizing). The `groupKey` is the group's email address or the group's unique `id`. The optional `roles` query string is a filter allowing you to retrieve group members by role and the resulting role collections are in the order given in the `roles` filter. For the request and response properties, see the [API Reference](/workspace/admin/directory/v1/reference/members/list). For readability, this example uses line returns: \n\n```\nGET https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members\n?pageToken=pagination token\n&roles=one or more of OWNER,MANAGER,MEMBER separated by a comma\n&maxResults=maximum results per response page\n```\n\nAll members are returned in the alphabetical order of the members' email addresses. And use the `pageToken` query string for responses with large number of members. In the case of pagination, the response returns the `nextPageToken` property which has a token for the next page of response results. Your next request uses this token as the `pageToken` query string value.\n\n### JSON response\n\nA successful response returns an [HTTP 200 status code](http://wikipedia.org/wiki/List_of_HTTP_status_codes) and the list of member information. The `id` is the member's unique membership ID. There is a `nextPageToken` for the follow-on list of group members in this response: \n\n```carbon\n{\n \"kind\": \"directory#members\",\n \"members\": [\n {\n \"kind\": \"directory#member\",\n \"id\": \"group member's unique ID\",\n \"email\": \"liz@example.com\",\n \"role\": \"MANAGER\",\n \"type\": \"USER\"\n },\n {\n \"kind\": \"directory#member\",\n \"id\": \"group member's unique ID\",\n \"email\": \"radhe@example.com\",\n \"role\": \"MANAGER\",\n \"type\": \"USER\"\n }\n ],\n \"nextPageToken\": \"NNNNN\"\n}\n```\n\nDelete membership in a group\n----------------------------\n\nTo delete a member's membership in a group, use the following `DELETE` request and include the authorization described in [Authorize requests](/workspace/admin/directory/v1/guides/authorizing). The `groupKey` is the group's unique `id`, and `memberKey` is the deleted user or group member's primary email address or the user's unique `id`. For the request and response properties, see the [API Reference](/workspace/admin/directory/v1/reference/members/delete).: \n\n```\nDELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey\n```\nFor example, this `DELETE` request deletes the member whose `groupKey` is nnn and whose `memberKey` is the user's primary email address, liz@example.com: \n\n```\nDELETE https://admin.googleapis.com/admin/directory/v1/groups/nnnn/members/liz@example.com\n```\n\nA successful response returns an [HTTP 200 status code](http://wikipedia.org/wiki/List_of_HTTP_status_codes).\n\nWhen a member is deleted:\n\n- Members you remove no longer receive email addressed to the group.\n- Removing a member from a group does not delete the user's account.\n- If you delete the group owner, the group still works normally. As an administrator, you can manage the group or assign ownership to another group member\n\n\u003cbr /\u003e"]]
