เพิ่มสมาชิกลงในกลุ่ม
หากต้องการเพิ่มสมาชิกลงในกลุ่ม ให้ใช้คำขอ POST
ต่อไปนี้และรวมการให้สิทธิ์ที่อธิบายไว้ในคำขอให้สิทธิ์ สมาชิกกลุ่มจะเป็นผู้ใช้หรือกลุ่มอื่นก็ได้ groupKey
คืออีเมลกลุ่มของสมาชิกใหม่หรือ id
ที่ไม่ซ้ำกันของกลุ่ม สำหรับพร็อพเพอร์ตี้คำขอและการตอบกลับ โปรดดูเอกสารอ้างอิง API ดังนี้
POST https://admin.googleapis.com/admin/directory/v1/groups/groupKey/members
หากคุณเพิ่มกลุ่มเป็นสมาชิกของกลุ่มอื่น อาจมีความล่าช้าถึง 10 นาทีก่อนที่สมาชิกของกลุ่มย่อยจะปรากฏเป็นสมาชิกของกลุ่มหลัก นอกจากนี้ API จะแสดงผลข้อผิดพลาดสำหรับรอบในการเป็นสมาชิกกลุ่ม เช่น หาก group1 เป็นสมาชิกของกลุ่ม 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 โดยใช้คอนโซลผู้ดูแลระบบเท่านั้น บทบาทผู้จัดการสามารถทำทุกอย่างโดยบทบาทเจ้าของ ยกเว้นการกำหนดให้สมาชิกเป็นเจ้าของหรือลบกลุ่ม กลุ่มหนึ่งๆ จะมีสมาชิกของ "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 สำหรับข้อมูลเกี่ยวกับบทบาทสมาชิก เจ้าของ และผู้จัดการ โปรดดูที่ศูนย์ช่วยเหลือสำหรับการดูแลระบบ:
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": "GROUP" }, { "kind": "directory#member", "id": "group member's unique ID", "email": "radhe@example.com", "role": "MANAGER", "type": "MEMBER" } ], "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
สิ่งที่จะเกิดขึ้นเมื่อลบสมาชิก
- สมาชิกที่คุณนำออกจะไม่ได้รับอีเมลที่ส่งถึงกลุ่มอีกต่อไป
- การนำสมาชิกออกจากกลุ่มจะไม่ลบบัญชีของผู้ใช้
- หากคุณลบเจ้าของกลุ่ม กลุ่มจะยังคงทำงานได้ตามปกติ ในฐานะผู้ดูแลระบบ คุณสามารถจัดการกลุ่มหรือมอบหมายความเป็นเจ้าของให้กับสมาชิกกลุ่มคนอื่นได้