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 โดยใช้คอนโซลผู้ดูแลระบบของ Google บทบาทผู้จัดการจะทำทุกอย่างได้เหมือนบทบาทเจ้าของ ยกเว้นการกำหนดให้สมาชิกเป็นเจ้าของหรือลบกลุ่ม กลุ่มหนึ่งๆ มีสมาชิกที่เป็นเจ้าของและผู้จัดการได้หลายคน
  • 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 PUT คำขอgroupKeyในตัวอย่างนี้คือ 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

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

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