Directory API: Thành viên nhóm

Thêm thành viên vào nhóm

Để thêm thành viên vào một nhóm, hãy sử dụng yêu cầu POST sau đây và thêm quyền uỷ quyền được mô tả trong phần Uỷ quyền yêu cầu. Thành viên của một nhóm có thể là một người dùng hoặc một nhóm khác. groupKey là địa chỉ email của nhóm của thành viên mới hoặc id duy nhất của nhóm. Đối với các thuộc tính yêu cầu và phản hồi, hãy xem Tài liệu tham khảo API: 

POST https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members

Nếu bạn thêm một nhóm làm thành viên của một nhóm khác, thì có thể mất tối đa 10 phút thì các thành viên của nhóm con mới xuất hiện với tư cách là thành viên của nhóm mẹ. Ngoài ra, API sẽ trả về lỗi cho các chu kỳ trong gói thành viên nhóm. Ví dụ: nếu group1 là thành viên của group2, thì group2 không thể là thành viên của group1.

Yêu cầu JSON

Yêu cầu JSON sau đây cho thấy nội dung yêu cầu mẫu để tạo thành viên nhóm. Địa chỉ email của thành viên là liz@example.com và vai trò của thành viên trong nhóm là MEMBER. Yêu cầu POST sử dụng NNNNN cho groupKey: 

POST https://admin.googleapis.com/admin/directory/v1/groups/NNNNN/members

{
   "email": "liz@example.com",
    "role": "MEMBER"
}

role của thành viên trong nhóm có thể là:

  • OWNER – Vai trò này có thể thay đổi chế độ gửi thư đến nhóm, thêm hoặc xoá thành viên, thay đổi vai trò của thành viên, thay đổi chế độ cài đặt của nhóm và xoá nhóm. OWNER phải là thành viên của nhóm.
  • MANAGER – Vai trò này chỉ có sẵn nếu bạn bật Google Workspace bằng Bảng điều khiển dành cho quản trị viên. Vai trò NGƯỜI QUẢN LÝ có thể làm mọi việc mà vai trò CHỦ SỞ HỮU có thể làm, ngoại trừ việc chỉ định thành viên làm CHỦ SỞ HỮU hoặc xoá nhóm. Một nhóm có thể có nhiều thành viên CHỦ SỞ HỮU và NGƯỜI QUẢN LÝ.
  • MEMBER – Vai trò này có thể đăng ký theo dõi một nhóm, xem bản lưu trữ cuộc thảo luận và xem danh sách thành viên của nhóm. Để biết thêm thông tin về vai trò của thành viên, hãy xem trung tâm trợ giúp dành cho quản trị viên.

Nội dung phản hồi JSON

Phản hồi thành công sẽ trả về mã trạng thái HTTP 200 và thông tin thành viên của người dùng. id là mã thành viên duy nhất của thành viên: 

{
   "kind": "directory#member",
   "id": "group member's unique ID",
   "email": "liz@example.com",
   "role": "MEMBER",
   "type": "GROUP"
  }

type của thành viên trong nhóm có thể là:

  • GROUP – Thành phần là một nhóm khác.
  • MEMBER – Thành viên là người dùng

Cập nhật tư cách thành viên nhóm

Để cập nhật tư cách thành viên của một nhóm, hãy sử dụng yêu cầu PUT sau đây và thêm thông tin uỷ quyền được mô tả trong phần Uỷ quyền yêu cầu. groupKey là địa chỉ email của nhóm hoặc id duy nhất của nhóm, còn memberKey là địa chỉ email chính của người dùng hoặc nhóm, địa chỉ email đại diện của người dùng hoặc id duy nhất của người dùng. Đối với các thuộc tính yêu cầu và phản hồi, hãy xem Tài liệu tham khảo API: 

PUT https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey

Yêu cầu JSON

Yêu cầu JSON sau đây cho thấy nội dung yêu cầu mẫu cập nhật chế độ cài đặt tư cách thành viên trong nhóm. Địa chỉ email của thành viên là liz@example.com và vai trò của thành viên trong nhóm được thay đổi từ MEMBER thành MANAGER. groupKey của yêu cầu PUT trong ví dụ này là NNNNN. Để biết thông tin về vai trò THÀNH VIÊN, CHỦ SỞ HỮU và QUẢN LÝ, hãy xem trung tâm trợ giúp dành cho quản trị viên: 

PUT https://admin.googleapis.com/admin/directory/v1/groups/NNNNN/members/liz@example.com
 
{
   "email": "liz@example.com",
    "role": "MANAGER"
}

Nội dung phản hồi JSON

Phản hồi thành công sẽ trả về mã trạng thái HTTP 200 và thông tin thành viên đã cập nhật. id là mã thành viên duy nhất của thành viên: 

{
   "kind": "directory#member",
   "id": "group member's unique ID",
   "email": "liz@example.com",
   "role": "MANAGER",
   "type": "GROUP"
  }

Truy xuất thành viên của một nhóm

Để truy xuất tư cách thành viên của một nhóm, hãy sử dụng yêu cầu GET sau đây và thêm thông tin uỷ quyền được mô tả trong phần Uỷ quyền yêu cầu. groupKey là địa chỉ email của nhóm hoặc id duy nhất của nhóm, còn memberKey là địa chỉ email chính của người dùng hoặc nhóm, địa chỉ email đại diện của người dùng hoặc id duy nhất của người dùng. Đối với các thuộc tính yêu cầu và phản hồi, hãy xem Tài liệu tham khảo API: 

GET https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey

Nội dung phản hồi JSON

Phản hồi thành công sẽ trả về mã trạng thái HTTP 200 và thông tin thành viên của người dùng. id là mã thành viên duy nhất của thành viên: 

{
   "kind": "directory#member",
   "id": "group member's unique ID",
   "email": "liz@example.com",
   "role": "MANAGER",
   "type": "GROUP"
  }

Truy xuất tất cả thành viên trong nhóm

Để truy xuất tất cả thành viên trong nhóm, hãy sử dụng yêu cầu GET sau đây và thêm thông tin uỷ quyền được mô tả trong phần Uỷ quyền yêu cầu. groupKey là địa chỉ email của nhóm hoặc id duy nhất của nhóm. Chuỗi truy vấn roles (không bắt buộc) là một bộ lọc cho phép bạn truy xuất thành viên nhóm theo vai trò và các tập hợp vai trò thu được sẽ theo thứ tự được cung cấp trong bộ lọc roles. Đối với các thuộc tính yêu cầu và phản hồi, hãy xem Tài liệu tham khảo API. Để dễ đọc, ví dụ này sử dụng các dòng trả về: 

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

Tất cả thành viên được trả về theo thứ tự bảng chữ cái của địa chỉ email của thành viên. Và sử dụng chuỗi truy vấn pageToken cho các phản hồi có số lượng thành viên lớn. Trong trường hợp phân trang, phản hồi sẽ trả về thuộc tính nextPageToken có mã thông báo cho trang tiếp theo của kết quả phản hồi. Yêu cầu tiếp theo của bạn sẽ sử dụng mã thông báo này làm giá trị chuỗi truy vấn pageToken.

Nội dung phản hồi JSON

Phản hồi thành công sẽ trả về mã trạng thái HTTP 200 và danh sách thông tin thành viên. id là mã thành viên duy nhất của thành viên. Có một nextPageToken cho danh sách tiếp theo của các thành viên trong nhóm trong phản hồi này: 

{
   "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"
}

Xoá tư cách thành viên trong nhóm

Để xoá tư cách thành viên của một thành viên trong nhóm, hãy sử dụng yêu cầu DELETE sau đây và thêm thông tin uỷ quyền được mô tả trong phần Uỷ quyền yêu cầu. groupKey là id duy nhất của nhóm và memberKey là địa chỉ email chính của người dùng hoặc thành viên nhóm đã bị xoá hoặc id duy nhất của người dùng. Đối với các thuộc tính yêu cầu và phản hồi, hãy xem Tài liệu tham khảo API.: 

DELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members/memberKey
 Ví dụ: yêu cầu DELETE này sẽ xoá thành viên có groupKey là nnn và memberKey là địa chỉ email chính của người dùng, liz@example.com: 
DELETE https://admin.googleapis.com/admin/directory/v1/groups/nnnn/members/liz@example.com

Phản hồi thành công sẽ trả về mã trạng thái HTTP 200.

Khi một thành viên bị xoá:

  • Những thành viên mà bạn xoá sẽ không nhận được email gửi đến nhóm nữa.
  • Việc xoá một thành viên khỏi nhóm sẽ không xoá tài khoản của người dùng đó.
  • Nếu bạn xoá chủ sở hữu nhóm, nhóm vẫn hoạt động bình thường. Với tư cách là quản trị viên, bạn có thể quản lý nhóm hoặc chỉ định quyền sở hữu cho một thành viên khác trong nhóm