Admin SDK: Directory API

Directory API ของ Admin SDK ช่วยให้ผู้ดูแลระบบของโดเมนระดับองค์กรดูและจัดการผู้ใช้ กลุ่ม อุปกรณ์ และทรัพยากรที่เกี่ยวข้องขององค์กรได้ Cloud Identity API มีวิธีเพิ่มเติมในการจัดการทรัพยากรบางอย่างที่เหมือนกัน

บริการ: admin.googleapis.com

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

เอกสารการค้นหา

เอกสารการค้นหาเป็นข้อกำหนดที่เครื่องอ่านได้สำหรับการอธิบายและการใช้ REST API โดยใช้เพื่อสร้างไลบรารีของไคลเอ็นต์ ปลั๊กอิน IDE และเครื่องมืออื่นๆ ที่โต้ตอบกับ Google API บริการหนึ่งๆ อาจมีเอกสารการค้นหาหลายรายการ บริการนี้มีเอกสารการค้นพบต่อไปนี้

ปลายทางบริการ

ปลายทางบริการคือ URL ฐานที่ระบุที่อยู่เครือข่ายของบริการ API บริการหนึ่งๆ อาจมีปลายทางบริการหลายรายการ บริการนี้มีปลายทางของบริการต่อไปนี้ และ URI ทั้งหมดด้านล่างจะเกี่ยวข้องกับปลายทางของบริการนี้

  • https://admin.googleapis.com

ทรัพยากร REST: asps

เมธอด
delete DELETE /admin/directory/v1/users/{userKey}/asps/{codeId}
ลบ ASP ที่ผู้ใช้ออกให้
get GET /admin/directory/v1/users/{userKey}/asps/{codeId}
รับข้อมูลเกี่ยวกับ ASP ที่ผู้ใช้ออก
list GET /admin/directory/v1/users/{userKey}/asps
แสดง ASP ที่ผู้ใช้ออก

ทรัพยากร REST: chromeosdevices

เมธอด
action
(deprecated)		 POST /admin/directory/v1/customer/{customerId}/devices/chromeos/{resourceId}/action
ใช้ BatchChangeChromeOsDeviceStatus แทน
get GET /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}
ดึงข้อมูลพร็อพเพอร์ตี้ของอุปกรณ์ Chrome OS
list GET /admin/directory/v1/customer/{customerId}/devices/chromeos
ดึงรายการอุปกรณ์ ChromeOS ที่แบ่งหน้าภายในบัญชี
moveDevicesToOu POST /admin/directory/v1/customer/{customerId}/devices/chromeos/moveDevicesToOu
ย้ายหรือแทรกอุปกรณ์ ChromeOS หลายเครื่องไปยังหน่วยขององค์กร
patch PATCH /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}
อัปเดตพร็อพเพอร์ตี้ที่อัปเดตได้ของอุปกรณ์ เช่น annotatedUser, annotatedLocation, notes, orgUnitPath หรือ annotatedAssetId
update PUT /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}
อัปเดตพร็อพเพอร์ตี้ที่อัปเดตได้ของอุปกรณ์ เช่น annotatedUser, annotatedLocation, notes, orgUnitPath หรือ annotatedAssetId

ทรัพยากร REST: customer.devices.chromeos

เมธอด
batchChangeStatus POST /admin/directory/v1/customer/{customerId}/devices/chromeos:batchChangeStatus
เปลี่ยนสถานะของอุปกรณ์ ChromeOS หลายเครื่อง
countChromeOsDevices GET /admin/directory/v1/customer/{customerId}/devices/chromeos:countChromeOsDevices
นับอุปกรณ์ ChromeOS ที่ตรงกับคำขอ
issueCommand POST /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}:issueCommand
ออกคำสั่งให้อุปกรณ์ดำเนินการ

ทรัพยากร REST: customer.devices.chromeos.commands

เมธอด
get GET /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}/commands/{commandId}
รับข้อมูลคำสั่งของคำสั่งที่เฉพาะเจาะจงซึ่งออกให้กับอุปกรณ์

ทรัพยากร REST: customers

เมธอด
get GET /admin/directory/v1/customers/{customerKey}
ดึงข้อมูลลูกค้า
patch PATCH /admin/directory/v1/customers/{customerKey}
แก้ไขลูกค้า
update PUT /admin/directory/v1/customers/{customerKey}
อัปเดตลูกค้า

ทรัพยากร REST: domainAliases

เมธอด
delete DELETE /admin/directory/v1/customer/{customer}/domainaliases/{domainAliasName}
ลบชื่อแทนโดเมนของลูกค้า
get GET /admin/directory/v1/customer/{customer}/domainaliases/{domainAliasName}
ดึงข้อมูลชื่อแทนโดเมนของลูกค้า
insert POST /admin/directory/v1/customer/{customer}/domainaliases
แทรกชื่อแทนโดเมนของลูกค้า
list GET /admin/directory/v1/customer/{customer}/domainaliases
แสดงรายการชื่อแทนโดเมนของลูกค้า

ทรัพยากร REST: domains

เมธอด
delete DELETE /admin/directory/v1/customer/{customer}/domains/{domainName}
ลบโดเมนของลูกค้า
get GET /admin/directory/v1/customer/{customer}/domains/{domainName}
ดึงข้อมูลโดเมนของลูกค้า
insert POST /admin/directory/v1/customer/{customer}/domains
แทรกโดเมนของลูกค้า
list GET /admin/directory/v1/customer/{customer}/domains
แสดงรายการโดเมนของลูกค้า

ทรัพยากร REST: groups

เมธอด
delete DELETE /admin/directory/v1/groups/{groupKey}
ลบกลุ่ม
get GET /admin/directory/v1/groups/{groupKey}
เรียกข้อมูลพร็อพเพอร์ตี้ของกลุ่ม
insert POST /admin/directory/v1/groups
สร้างกลุ่ม
list GET /admin/directory/v1/groups
ดึงข้อมูลกลุ่มทั้งหมดของโดเมนหรือของผู้ใช้ที่ระบุ userKey (แบ่งหน้า)
patch PATCH /admin/directory/v1/groups/{groupKey}
อัปเดตพร็อพเพอร์ตี้ของกลุ่ม
update PUT /admin/directory/v1/groups/{groupKey}
อัปเดตพร็อพเพอร์ตี้ของกลุ่ม

ทรัพยากร REST: groups.aliases

เมธอด
delete DELETE /admin/directory/v1/groups/{groupKey}/aliases/{alias}
นำชื่อแทนออก
insert POST /admin/directory/v1/groups/{groupKey}/aliases
เพิ่มชื่อแทนสำหรับกลุ่ม
list GET /admin/directory/v1/groups/{groupKey}/aliases
แสดงรายการอีเมลแทนทั้งหมดของกลุ่ม

ทรัพยากร REST: members

เมธอด
delete DELETE /admin/directory/v1/groups/{groupKey}/members/{memberKey}
นำสมาชิกออกจากกลุ่ม
get GET /admin/directory/v1/groups/{groupKey}/members/{memberKey}
เรียกข้อมูลพร็อพเพอร์ตี้ของสมาชิกกลุ่ม
hasMember GET /admin/directory/v1/groups/{groupKey}/hasMember/{memberKey}
ตรวจสอบว่าผู้ใช้ที่ระบุเป็นสมาชิกของกลุ่มหรือไม่
insert POST /admin/directory/v1/groups/{groupKey}/members
เพิ่มผู้ใช้ไปยังกลุ่มที่ระบุ
list GET /admin/directory/v1/groups/{groupKey}/members
ดึงรายการสมาชิกทั้งหมดในกลุ่มที่แบ่งหน้า
patch PATCH /admin/directory/v1/groups/{groupKey}/members/{memberKey}
อัปเดตพร็อพเพอร์ตี้การเป็นสมาชิกของผู้ใช้ในกลุ่มที่ระบุ
update PUT /admin/directory/v1/groups/{groupKey}/members/{memberKey}
อัปเดตการเป็นสมาชิกของผู้ใช้ในกลุ่มที่ระบุ

ทรัพยากร REST: mobiledevices

เมธอด
action POST /admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}/action
ดำเนินการที่ส่งผลต่ออุปกรณ์เคลื่อนที่
delete DELETE /admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}
นำอุปกรณ์เคลื่อนที่ออก
get GET /admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}
ดึงข้อมูลพร็อพเพอร์ตี้ของอุปกรณ์เคลื่อนที่
list GET /admin/directory/v1/customer/{customerId}/devices/mobile
ดึงข้อมูลรายการอุปกรณ์เคลื่อนที่ทั้งหมดที่เป็นของผู้ใช้สำหรับบัญชีหนึ่งๆ โดยแบ่งเป็นหน้า

ทรัพยากร REST: orgunits

เมธอด
delete DELETE /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}
นำหน่วยขององค์กรออก
get GET /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}
ดึงข้อมูลหน่วยขององค์กร
insert POST /admin/directory/v1/customer/{customerId}/orgunits
เพิ่มหน่วยขององค์กร
list GET /admin/directory/v1/customer/{customerId}/orgunits
ดึงรายการหน่วยขององค์กรทั้งหมดสำหรับบัญชี
patch PATCH /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}
อัปเดตหน่วยขององค์กร
update PUT /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}
อัปเดตหน่วยขององค์กร

ทรัพยากร REST: privileges

เมธอด
list GET /admin/directory/v1/customer/{customer}/roles/ALL/privileges
ดึงรายการสิทธิ์ทั้งหมดของลูกค้าที่แบ่งหน้า

ทรัพยากร REST: resources.buildings

เมธอด
delete DELETE /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}
ลบอาคาร
get GET /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}
ดึงข้อมูลอาคาร
insert POST /admin/directory/v1/customer/{customer}/resources/buildings
แทรกอาคาร
list GET /admin/directory/v1/customer/{customer}/resources/buildings
ดึงข้อมูลรายการอาคารสำหรับบัญชี
patch PATCH /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}
แก้ไขอาคาร
update PUT /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}
อัปเดตอาคาร

ทรัพยากร REST: resources.calendars

เมธอด
delete DELETE /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}
ลบทรัพยากรในปฏิทิน
get GET /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}
เรียกข้อมูลทรัพยากรในปฏิทิน
insert POST /admin/directory/v1/customer/{customer}/resources/calendars
แทรกทรัพยากรในปฏิทิน
list GET /admin/directory/v1/customer/{customer}/resources/calendars
ดึงข้อมูลรายการทรัพยากรในปฏิทินสำหรับบัญชี
patch PATCH /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}
แก้ไขทรัพยากรในปฏิทิน
update PUT /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}
อัปเดตทรัพยากรในปฏิทิน

ทรัพยากร REST: resources.features

เมธอด
delete DELETE /admin/directory/v1/customer/{customer}/resources/features/{featureKey}
ลบลักษณะ
get GET /admin/directory/v1/customer/{customer}/resources/features/{featureKey}
ดึงข้อมูลฟีเจอร์
insert POST /admin/directory/v1/customer/{customer}/resources/features
แทรกฟีเจอร์
list GET /admin/directory/v1/customer/{customer}/resources/features
ดึงรายการฟีเจอร์สำหรับบัญชี
patch PATCH /admin/directory/v1/customer/{customer}/resources/features/{featureKey}
แก้ไขฟีเจอร์
rename POST /admin/directory/v1/customer/{customer}/resources/features/{oldName}/rename
เปลี่ยนชื่อฟีเจอร์
update PUT /admin/directory/v1/customer/{customer}/resources/features/{featureKey}
อัปเดตฟีเจอร์

ทรัพยากร REST: roleAssignments

เมธอด
delete DELETE /admin/directory/v1/customer/{customer}/roleassignments/{roleAssignmentId}
ลบการมอบหมายบทบาท
get GET /admin/directory/v1/customer/{customer}/roleassignments/{roleAssignmentId}
ดึงข้อมูลการมอบหมายบทบาท
insert POST /admin/directory/v1/customer/{customer}/roleassignments
สร้างการมอบหมายบทบาท
list GET /admin/directory/v1/customer/{customer}/roleassignments
ดึงรายการ roleAssignments ทั้งหมดที่แบ่งหน้า

ทรัพยากร REST: roles

เมธอด
delete DELETE /admin/directory/v1/customer/{customer}/roles/{roleId}
ลบบทบาท
get GET /admin/directory/v1/customer/{customer}/roles/{roleId}
ดึงข้อมูลบทบาท
insert POST /admin/directory/v1/customer/{customer}/roles
สร้างบทบาท
list GET /admin/directory/v1/customer/{customer}/roles
ดึงข้อมูลรายการแบบแบ่งหน้าของบทบาททั้งหมดในโดเมน
patch PATCH /admin/directory/v1/customer/{customer}/roles/{roleId}
แก้ไขบทบาท
update PUT /admin/directory/v1/customer/{customer}/roles/{roleId}
อัปเดตบทบาท

ทรัพยากร REST: schemas

เมธอด
delete DELETE /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}
ลบสคีมา
get GET /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}
ดึงข้อมูลสคีมา
insert POST /admin/directory/v1/customer/{customerId}/schemas
สร้างสคีมา
list GET /admin/directory/v1/customer/{customerId}/schemas
ดึงข้อมูลสคีมาทั้งหมดสำหรับลูกค้า
patch PATCH /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}
แก้ไขสคีมา
update PUT /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}
อัปเดตสคีมา

ทรัพยากร REST: tokens

เมธอด
delete DELETE /admin/directory/v1/users/{userKey}/tokens/{clientId}
ลบโทเค็นเพื่อการเข้าถึงทั้งหมดที่ผู้ใช้ออกให้แอปพลิเคชัน
get GET /admin/directory/v1/users/{userKey}/tokens/{clientId}
รับข้อมูลเกี่ยวกับโทเค็นเพื่อการเข้าถึงที่ผู้ใช้ออก
list GET /admin/directory/v1/users/{userKey}/tokens
แสดงชุดโทเค็นที่ผู้ใช้ที่ระบุออกให้กับแอปพลิเคชันของบุคคลที่สาม

ทรัพยากร REST: twoStepVerification

เมธอด
turnOff POST /admin/directory/v1/users/{userKey}/twoStepVerification/turnOff
ปิดการยืนยันแบบ 2 ขั้นตอนสำหรับผู้ใช้

ทรัพยากร REST: users

เมธอด
delete DELETE /admin/directory/v1/users/{userKey}
ลบผู้ใช้
get GET /admin/directory/v1/users/{userKey}
ดึงข้อมูลผู้ใช้
insert POST /admin/directory/v1/users
สร้างผู้ใช้
list GET /admin/directory/v1/users
ดึงข้อมูลรายการผู้ใช้ที่ถูกลบหรือผู้ใช้ทั้งหมดในโดเมนที่แบ่งหน้า
makeAdmin POST /admin/directory/v1/users/{userKey}/makeAdmin
กำหนดให้ผู้ใช้เป็นผู้ดูแลระบบขั้นสูง
patch PATCH /admin/directory/v1/users/{userKey}
อัปเดตผู้ใช้โดยใช้แพตช์
signOut POST /admin/directory/v1/users/{userKey}/signOut
นำผู้ใช้ออกจากเซสชันเว็บและอุปกรณ์ทั้งหมด รวมถึงรีเซ็ตคุกกี้การลงชื่อเข้าใช้
undelete POST /admin/directory/v1/users/{userKey}/undelete
เลิกการลบผู้ใช้ที่ถูกลบ
update PUT /admin/directory/v1/users/{userKey}
อัปเดตผู้ใช้
watch POST /admin/directory/v1/users/watch
ตรวจสอบการเปลี่ยนแปลงในรายชื่อผู้ใช้

ทรัพยากร REST: users.aliases

เมธอด
delete DELETE /admin/directory/v1/users/{userKey}/aliases/{alias}
นำชื่อแทนออก
insert POST /admin/directory/v1/users/{userKey}/aliases
เพิ่มชื่อแทน
list GET /admin/directory/v1/users/{userKey}/aliases
แสดงรายการอีเมลแทนทั้งหมดสำหรับผู้ใช้
watch POST /admin/directory/v1/users/{userKey}/aliases/watch
ตรวจสอบการเปลี่ยนแปลงในรายชื่อผู้ใช้

ทรัพยากร REST: users.photos

เมธอด
delete DELETE /admin/directory/v1/users/{userKey}/photos/thumbnail
นำรูปภาพของผู้ใช้ออก
get GET /admin/directory/v1/users/{userKey}/photos/thumbnail
ดึงรูปภาพของผู้ใช้
patch PATCH /admin/directory/v1/users/{userKey}/photos/thumbnail
เพิ่มรูปภาพให้ผู้ใช้
update PUT /admin/directory/v1/users/{userKey}/photos/thumbnail
เพิ่มรูปภาพให้ผู้ใช้

ทรัพยากร REST: verificationCodes

เมธอด
generate POST /admin/directory/v1/users/{userKey}/verificationCodes/generate
สร้างรหัสยืนยันสำรองใหม่สำหรับผู้ใช้
invalidate POST /admin/directory/v1/users/{userKey}/verificationCodes/invalidate
ทำให้รหัสยืนยันสำรองปัจจุบันของผู้ใช้ใช้ไม่ได้
list GET /admin/directory/v1/users/{userKey}/verificationCodes
แสดงชุดรหัสยืนยันสำรองที่ถูกต้องในปัจจุบันสำหรับผู้ใช้ที่ระบุ