Directory API: สมาชิกกลุ่ม

เพิ่มสมาชิกในกลุ่ม

หากต้องการเพิ่มสมาชิกในกลุ่ม ให้ใช้คําขอ 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 คืออีเมลหลักของผู้ใช้ อีเมลแทนของกลุ่ม หรือ #id39 ที่ไม่ซ้ํากันของผู้ใช้ สําหรับพร็อพเพอร์ตี้คําขอและการตอบกลับ โปรดดูเอกสารอ้างอิง 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 คืออีเมลหลักของผู้ใช้ อีเมลแทนของกลุ่ม หรือ #id39 ที่ไม่ซ้ํากันของผู้ใช้ สําหรับพร็อพเพอร์ตี้คําขอและการตอบกลับ โปรดดูเอกสารอ้างอิง 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

สิ่งที่จะเกิดขึ้นเมื่อลบสมาชิก

  • สมาชิกที่คุณนําออกจะไม่ได้รับอีเมลที่ส่งไปยังกลุ่มอีกต่อไป
  • การนําสมาชิกออกจากกลุ่มจะไม่ลบบัญชีของผู้ใช้
  • หากคุณลบเจ้าของกลุ่ม กลุ่มจะยังคงทํางานได้ตามปกติ ในฐานะผู้ดูแลระบบ คุณสามารถจัดการกลุ่มหรือมอบหมายความเป็นเจ้าของให้กับสมาชิกกลุ่มคนอื่นได้