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 Yêu cầu cho phép. Thành viên trong nhóm có thể là người dùng hoặc nhóm khác. groupKey là địa chỉ email nhóm của thành viên mới hoặc id duy nhất của 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 với tư cách thành viên của một nhóm khác, 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 sẽ trả về lỗi cho các chu kỳ trong tư cách thành viên nhóm. Ví dụ: Nếu nhóm 1 là thành viên của nhóm 2 thì nhóm 2 không thể là thành viên của nhóm 1.
Yêu cầu JSON
Yêu cầu JSON sau đây hiển thị nội dung yêu cầu mẫu tạo một 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 này 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 việc gửi tin nhắn đế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.OWNERphải là một thành viên của nhóm.MANAGER– Vai trò này chỉ 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ể thực hiện mọi việc do vai trò CHỦ SỞ HỮU thực hiện, ngoại trừ việc chỉ định 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 OWNER và MANAGER.MEMBER– Vai trò này có thể đăng ký 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ò thành viên, hãy xem trung tâm trợ giúp quản trị.
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 thành viên. id là mã thành viên duy nhất của hội 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 trong nhóm
Để cập nhật một thành viên trong nhóm, hãy sử dụng yêu cầu PUT sau đây và thêm quyền uỷ quyền được mô tả trong phần Yêu cầu cho phép. 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. Để 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 hiển thị một nội dung yêu cầu mẫu cập nhật chế độ cài đặt tư cách thành viên của 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à NGƯỜI 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
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 cập nhật. id là mã thành viên duy nhất của hội 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 thành viên nhóm, hãy sử dụng yêu cầu GET sau đây và thêm quyền uỷ quyền được mô tả trong phần Yêu cầu cho phép. 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. Để 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
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 thành viên. id là mã thành viên duy nhất của hội 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 quyền uỷ quyền được mô tả trong phần Cho phép 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 các thành viên trong nhóm theo vai trò và các tập hợp vai trò thu được theo thứ tự nêu 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 phương thức 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 đều được trả về theo thứ tự bảng chữ cái trong địa chỉ email của hội viên. Đồng thời, 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. Thuộc tính này 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 hội viên. Có một nextPageToken cho danh sách muốn theo dõi gồm các thành viên nhóm 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": "GROUP"
},
{
"kind": "directory#member",
"id": "group member's unique ID",
"email": "radhe@example.com",
"role": "MANAGER",
"type": "MEMBER"
}
],
"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 một nhóm, hãy sử dụng yêu cầu DELETE sau đây và thêm quyền uỷ quyền được mô tả trong phần Yêu cầu cho phép. 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 đó. Để 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/memberKeyVí 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
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á:
- Các thành viên mà bạn xoá sẽ không nhận được email gửi tới nhóm nữa.
- Việc xóa thành viên khỏi một nhóm sẽ không xóa 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. 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 thành viên khác trong nhóm