Directory API: اعضای گروه
با مجموعه‌ها، منظم بمانید
ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.
عضوی را به یک گروه اضافه کنید
برای افزودن یک عضو به یک گروه، از درخواست POST زیر استفاده کنید و مجوز شرح داده شده در درخواست‌های مجاز را اضافه کنید. یک عضو گروه می تواند کاربر یا گروه دیگری باشد. groupKey آدرس ایمیل گروه عضو جدید یا id منحصر به فرد گروه است. برای خواص درخواست و پاسخ، به مرجع API مراجعه کنید:
POST https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members
اگر گروهی را به عنوان عضوی از گروه دیگری اضافه کنید، ممکن است تا 10 دقیقه تأخیر پیش از ظاهر شدن اعضای گروه فرزند به عنوان اعضای گروه والدین وجود داشته باشد. علاوه بر این، API یک خطا را برای چرخه های عضویت گروه برمی گرداند. برای مثال، اگر گروه 1 عضو گروه 2 باشد، گروه 2 نمی تواند عضو گروه 1 باشد.
درخواست JSON
درخواست JSON زیر یک بدنه درخواست نمونه را نشان می دهد که یک عضو گروه را ایجاد می کند. آدرس ایمیل اعضا liz@example.com است و نقش عضو در گروه به عنوان یک MEMBER است. درخواست POST از NNNNN برای groupKey استفاده می کند:
POST https://admin.googleapis.com/admin/directory/v1/groups/NNNNN/members
{
"email": "liz@example.com",
"role": "MEMBER"
} role یک عضو گروه می تواند این باشد:
-
OWNER - این نقش می تواند پیام های ارسالی به گروه را تغییر دهد، اعضا را اضافه یا حذف کند، نقش های اعضا را تغییر دهد، تنظیمات گروه را تغییر دهد و گروه را حذف کند. OWNER باید عضو گروه باشد. -
MANAGER - این نقش تنها در صورتی در دسترس است که Google Workspace با استفاده از کنسول Admin فعال باشد. یک نقش MANAGER می‌تواند همه کارهایی را که توسط یک نقش OWNER انجام می‌شود انجام دهد، به جز اینکه عضوی را به عنوان OWNER یا گروه را حذف کند. یک گروه می تواند چندین عضو OWNER و MANAGER داشته باشد. -
MEMBER - این نقش می تواند در یک گروه مشترک شود، آرشیوهای بحث را مشاهده کند و لیست عضویت گروه را مشاهده کند. برای اطلاعات بیشتر در مورد نقش اعضا، به مرکز راهنمایی مدیریت مراجعه کنید.
پاسخ JSON
یک پاسخ موفق ، کد وضعیت HTTP 200 و اطلاعات عضویت اعضا را برمی‌گرداند. 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 تغییر می کند. groupKey درخواست PUT در این مثال 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 عضویت منحصر به فرد عضو است:
{
"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 عضویت منحصر به فرد عضو است:
{
"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 شناسه عضویت منحصر به فرد اعضا است. یک 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 را برمی گرداند.
هنگامی که یک عضو حذف می شود:
- اعضایی که حذف می‌کنید دیگر ایمیلی به آدرس گروه دریافت نمی‌کنند.
- حذف یک عضو از یک گروه، حساب کاربر را حذف نمی کند.
- اگر مالک گروه را حذف کنید، گروه همچنان به طور عادی کار می کند. به عنوان یک سرپرست، می توانید گروه را مدیریت کنید یا مالکیت را به یکی دیگر از اعضای گروه واگذار کنید
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین به‌روزرسانی 2025-08-29 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین به‌روزرسانی 2025-08-29 بهوقت ساعت هماهنگ جهانی."],[],[],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"]]
