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à bao gồm quyền uỷ quyền như mô tả trong phần Uỷ quyền yêu cầu. Thành viên trong nhóm có thể là một người dùng hoặc một nhóm khác. groupKey là địa chỉ email nhóm của thành viên mới hoặc id của riêng nhóm. Để biết 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 nhóm khác, thì có thể phải mất tới 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 này sẽ trả về lỗi đối với các chu kỳ trong tư cách thành viên trong 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 một nội dung yêu cầu mẫu sẽ tạo một 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 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 một thành viên nhóm có thể là:

  • OWNER – Vai trò này có thể thay đổi cách gửi tin nhắn cho 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à một thành viên của nhóm.
  • MANAGER – Vai trò này chỉ dùng được 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 làm mọi việc, ngoại trừ chỉ định một thành viên làm CHỦ SỞ HỮU hoặc xóa 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ý vào một nhóm, xem bản lưu trữ các 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ề các vai trò thành viên, hãy xem trung tâm trợ giúp quản trị.

Nội dung phản hồi JSON

Khi phản hồi thành công, hệ thống sẽ trả về mã trạng thái HTTP 200 và thông tin thành viên của thành viên. 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 một thành viên nhóm có thể là:

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

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

Để cập nhật một tư cách thành viên trong nhóm, hãy dùng yêu cầu PUT sau đây và bao gồm quyền 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 của riêng người dùng. Để biết 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 một nội dung yêu cầu mẫu giúp cập nhật các 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 sẽ 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à NGƯỜI QUẢN LÝ, hãy xem trung tâm trợ giúp quản trị: 

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

Khi phản hồi thành công, hệ thố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 nhóm

Để truy xuất một tư cách thành viên nhóm, hãy sử dụng yêu cầu GET sau đây và bao gồm 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 của riêng người dùng. Để biết 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

Khi phản hồi thành công, hệ thống sẽ trả về mã trạng thái HTTP 200 và thông tin thành viên của thành viên. 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 nhóm

Để truy xuất tất cả thành viên nhóm, hãy dùng yêu cầu GET sau đây và bao gồm quyền 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 trong nhóm theo vai trò. Sau đó, các tập hợp vai trò thu được sẽ được sắp xếp theo thứ tự được cung cấp trong bộ lọc roles. Để biết 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 giá trị trả về dòng: 

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ả hội viên sẽ được trả về theo thứ tự bảng chữ cái của danh sách hội viên địa chỉ email. Đồng thời, hãy sử dụng chuỗi truy vấn pageToken cho các phản hồi có nhiều thành viê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 kết quả phản hồi tiếp theo. Yêu cầu tiếp theo của bạn 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

Khi phản hồi thành công, hệ thố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 thành viên nhóm theo dõi trong câu trả lờ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à bao gồm việc uỷ quyền như mô tả trong phần Uỷ quyền cho các 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ị xóa hoặc id của riêng người dùng. Để biết 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à có 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

Khi phản hồi thành công, hệ thống sẽ trả về mã trạng thái HTTP 200.

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

  • Các thành viên bạn xoá sẽ không nhận được email gửi đến nhóm nữa.
  • Việc xoá 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 này vẫn hoạt động bình thường. Là quản trị viên, bạn có thể quản lý nhóm hoặc giao quyền sở hữu cho một thành viên khác trong nhóm