เลือกขอบเขตของ Directory API

เอกสารนี้มีการให้สิทธิ์เฉพาะสำหรับ API ไดเรกทอรีและข้อมูลการตรวจสอบสิทธิ์ ก่อนอ่านเอกสารนี้ โปรดอ่านข้อมูลการตรวจสอบสิทธิ์ทั่วไปและการให้สิทธิ์ของ Google Workspace ที่ดูข้อมูลเกี่ยวกับการตรวจสอบสิทธิ์และการให้สิทธิ์

กำหนดค่า OAuth 2.0 สำหรับการให้สิทธิ์

กำหนดค่าหน้าจอคำยินยอม OAuth และเลือกขอบเขตเพื่อกำหนดข้อมูลที่แสดงต่อผู้ใช้และผู้ตรวจสอบแอป รวมถึงลงทะเบียนแอปเพื่อเผยแพร่แอปในภายหลัง

ขอบเขตของ Directory API

หากต้องการกำหนดระดับการเข้าถึงที่ให้แก่แอป คุณต้องระบุและประกาศขอบเขตการให้สิทธิ์ ขอบเขตการให้สิทธิ์คือสตริง URI ของ OAuth 2.0 ที่มีชื่อแอป Google Workspace, ประเภทข้อมูลที่เข้าถึง และระดับการเข้าถึง ขอบเขตคือคำขอที่แอปของคุณใช้เพื่อทำงานกับข้อมูล Google Workspace ซึ่งรวมถึงข้อมูลบัญชี Google ของผู้ใช้

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

Directory API รองรับขอบเขตต่อไปนี้

ขอบเขตสำหรับอุปกรณ์ ความหมาย
https://www.googleapis.com/auth/admin.directory.device.chromeos ขอบเขตรวมทั้งหมดสำหรับการเข้าถึงการดำเนินการทั้งหมดของอุปกรณ์ Chrome
https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly ขอบเขตในการเรียกข้อมูลอุปกรณ์ Chrome เท่านั้น
https://www.googleapis.com/auth/admin.directory.device.mobile ขอบเขตรวมทั้งหมดสำหรับการเข้าถึงการดำเนินการบนอุปกรณ์เคลื่อนที่ทั้งหมด
https://www.googleapis.com/auth/admin.directory.device.mobile.readonly ขอบเขตสำหรับการเรียกข้อมูลเฉพาะอุปกรณ์เคลื่อนที่
https://www.googleapis.com/auth/admin.directory.device.mobile.action ขอบเขตสำหรับงานที่มีการกระทำในอุปกรณ์เคลื่อนที่
ขอบเขตสำหรับกลุ่ม ชื่อแทนกลุ่ม และสมาชิกกลุ่ม ความหมาย
https://www.googleapis.com/auth/admin.directory.group.member ขอบเขตการเข้าถึงบทบาทของสมาชิกกลุ่มและการดำเนินการเกี่ยวกับข้อมูล
https://www.googleapis.com/auth/admin.directory.group.member.readonly ขอบเขตสําหรับเรียกเฉพาะบทบาทและข้อมูลของสมาชิกกลุ่มเท่านั้น
https://www.googleapis.com/auth/admin.directory.group ขอบเขตรวมทั้งหมดสำหรับการเข้าถึงการดำเนินการของกลุ่มทั้งหมด รวมถึงชื่อแทนและสมาชิกกลุ่ม
https://www.googleapis.com/auth/admin.directory.group.readonly ขอบเขตสำหรับการเรียกข้อมูลกลุ่ม ชื่อแทนกลุ่ม และสมาชิกกลุ่มเท่านั้น
ขอบเขตสำหรับหน่วยขององค์กร ความหมาย
https://www.googleapis.com/auth/admin.directory.orgunit ขอบเขตรวมสำหรับเข้าถึงการดำเนินการทั้งหมดในหน่วยขององค์กร
https://www.googleapis.com/auth/admin.directory.orgunit.readonly ขอบเขตสำหรับการเรียกข้อมูลเฉพาะหน่วยขององค์กร
ขอบเขตสำหรับผู้ใช้และชื่อแทนผู้ใช้ ความหมาย
https://www.googleapis.com/auth/admin.directory.user ขอบเขตรวมสำหรับการเข้าถึงการดำเนินการของผู้ใช้และชื่อแทนผู้ใช้ทั้งหมด
https://www.googleapis.com/auth/admin.directory.user.readonly ขอบเขตสำหรับการเรียกข้อมูลผู้ใช้หรือชื่อแทนผู้ใช้เท่านั้น
https://www.googleapis.com/auth/admin.directory.user.alias ขอบเขตสำหรับการเข้าถึงการดำเนินการอีเมลแทนของผู้ใช้ทั้งหมด
https://www.googleapis.com/auth/admin.directory.user.alias.readonly ขอบเขตในการเรียกเฉพาะชื่อแทนของผู้ใช้
ขอบเขตสำหรับฟีเจอร์ความปลอดภัยของผู้ใช้ ความหมาย
https://www.googleapis.com/auth/admin.directory.user.security ขอบเขตสำหรับการเข้าถึงการดำเนินการรหัสผ่านเฉพาะแอปพลิเคชัน โทเค็น OAuth และรหัสยืนยันทั้งหมด
ขอบเขตสำหรับการจัดการบทบาท ความหมาย
https://www.googleapis.com/auth/admin.directory.rolemanagement ขอบเขตสำหรับการดำเนินการจัดการบทบาททั้งหมด รวมถึงการสร้างบทบาทและการมอบหมายบทบาท
https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly ขอบเขตในการรับและแสดงรายการบทบาท สิทธิ์ และการมอบหมายบทบาท
ขอบเขตสำหรับสคีมาของผู้ใช้ที่กำหนดเอง ความหมาย
https://www.googleapis.com/auth/admin.directory.userschema ขอบเขตสำหรับการเข้าถึงการดำเนินการสคีมาของผู้ใช้ที่กำหนดเองทั้งหมด
https://www.googleapis.com/auth/admin.directory.userschema.readonly ขอบเขตสำหรับการเรียกข้อมูลเฉพาะสคีมาของผู้ใช้ที่กำหนดเองเท่านั้น
ขอบเขตสำหรับลูกค้า ความหมาย
https://www.googleapis.com/auth/admin.directory.customer ขอบเขตสำหรับการเข้าถึงการดำเนินการของลูกค้าทั้งหมด
https://www.googleapis.com/auth/admin.directory.customer.readonly ขอบเขตในการเรียกข้อมูลเฉพาะลูกค้า
ขอบเขตสำหรับโดเมน ความหมาย
https://www.googleapis.com/auth/admin.directory.domain ขอบเขตสำหรับการเข้าถึงการดำเนินการในโดเมนทั้งหมด
https://www.googleapis.com/auth/admin.directory.domain.readonly ขอบเขตสำหรับการเรียกข้อมูลโดเมนเท่านั้น
ขอบเขตสำหรับทรัพยากรปฏิทิน ความหมาย
https://www.googleapis.com/auth/admin.directory.resource.calendar ขอบเขตสำหรับการเข้าถึงการดำเนินการของทรัพยากรปฏิทินทั้งหมด
https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly ขอบเขตสำหรับการเรียกเฉพาะทรัพยากรปฏิทิน