Admin SDK: Directory API

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

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

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

เอกสารการค้นพบ

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

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

ปลายทางของบริการคือ 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: อุปกรณ์ chromeos

วิธีการ
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
เรียกข้อมูลรายการอุปกรณ์ Chrome OS ที่มีเลขหน้าภายในบัญชี
moveDevicesToOu POST /admin/directory/v1/customer/{customerId}/devices/chromeos/moveDevicesToOu
ย้ายหรือแทรกอุปกรณ์ Chrome OS หลายเครื่องไปยังหน่วยขององค์กร
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 กลุ่มหนึ่ง
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: โดเมน

วิธีการ
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: กลุ่ม

วิธีการ
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: สมาชิก

วิธีการ
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: สิทธิ์

วิธีการ
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: บทบาท

วิธีการ
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: สคีมา

วิธีการ
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: โทเค็น

วิธีการ
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: ผู้ใช้

วิธีการ
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
แสดงผลชุดรหัสยืนยันสำรองที่ถูกต้องในปัจจุบันสำหรับผู้ใช้ที่ระบุ