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" หรือลบกลุ่ม กลุ่มหนึ่งๆ จะมีสมาชิก 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": "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

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

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