เอกสารนี้มีข้อมูลการให้สิทธิ์และการตรวจสอบสิทธิ์เฉพาะสำหรับ Directory 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 | ขอบเขตสำหรับการดึงข้อมูลทรัพยากรในปฏิทินเท่านั้น |