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

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

หากต้องการเพิ่มสมาชิกลงในกลุ่ม ให้ใช้คำขอ POST ต่อไปนี้และรวมการให้สิทธิ์ที่อธิบายไว้ในคำขอสิทธิ์ สมาชิกกลุ่มอาจเป็นผู้ใช้หรือกลุ่มอื่นก็ได้ โดย groupKey คืออีเมลกลุ่มของสมาชิกใหม่หรือ id ที่ไม่ซ้ำกันของกลุ่ม ดูพร็อพเพอร์ตี้คำขอและการตอบกลับได้ในเอกสารอ้างอิง API 

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

หากคุณเพิ่มกลุ่มเป็นสมาชิกของอีกกลุ่มหนึ่ง ระบบอาจใช้เวลาถึง 10 นาทีก่อนที่สมาชิกของกลุ่มย่อยจะปรากฏเป็นสมาชิกของกลุ่มหลัก นอกจากนี้ API จะแสดงข้อผิดพลาดสำหรับรอบการเป็นสมาชิกกลุ่ม เช่น หาก group1 เป็นสมาชิกของ group2 แสดงว่า group2 จะเป็นสมาชิกของ group1 ไม่ได้

คำขอ 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 โดยใช้คอนโซลผู้ดูแลระบบเท่านั้น บทบาทผู้จัดการจะทำทุกอย่างได้เช่นเดียวกับบทบาทเจ้าของ ยกเว้นการทำให้สมาชิกเป็นเจ้าของหรือลบกลุ่ม กลุ่มหนึ่งจะมีสมาชิกที่มีบทบาทเป็น "เจ้าของ" และ "ผู้จัดการ" ได้หลายคน
  • 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": "USER"
   },
   {
    "kind": "directory#member",
    "id": "group member's unique ID",
    "email": "radhe@example.com",
    "role": "MANAGER",
    "type": "USER"
   }
  ],
   "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

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

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