Method: orgunits.list

เรียกข้อมูลรายการหน่วยขององค์กรทั้งหมดสำหรับบัญชี

คำขอ HTTP

GET https://admin.googleapis.com/admin/directory/v1/customer/{customerId}/orgunits

URL ใช้ไวยากรณ์การแปลง gRPC

พารามิเตอร์เส้นทาง

พารามิเตอร์
customerId

string

รหัสที่ไม่ซ้ำกันสำหรับบัญชี Google Workspace ของลูกค้า ในฐานะผู้ดูแลระบบบัญชี คุณใช้ชื่อแทน my_customer เพื่อแสดง customerId ของบัญชีได้ด้วย ระบบจะแสดงผล customerId เป็นส่วนหนึ่งของทรัพยากรของผู้ใช้ด้วย

พารามิเตอร์การค้นหา

พารามิเตอร์
orgUnitPath

string

เส้นทางแบบเต็มไปยังหน่วยขององค์กรหรือรหัสที่ไม่ซ้ำกัน แสดงผลรายการย่อยของหน่วยขององค์กรที่ระบุ

type

enum (Type)

จะส่งคืนองค์กรย่อยทั้งหมดหรือส่งคืนเฉพาะองค์กรย่อยโดยตรง

เนื้อหาของคำขอ

เนื้อหาของคำขอต้องว่างเปล่า

เนื้อหาการตอบกลับ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON
{
  "kind": string,
  "etag": string,
  "organizationUnits": [
    {
      object (OrgUnit)
    }
  ]
}
ช่อง
kind

string

ประเภทของทรัพยากร API สำหรับทรัพยากรหน่วยขององค์กร ประเภทคือ admin#directory#orgUnits

etag

string

ETag ของทรัพยากร

organizationUnits[]

object (OrgUnit)

รายการออบเจ็กต์หน่วยขององค์กร

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth รายการใดรายการหนึ่งต่อไปนี้

  • https://apps-apis.google.com/a/feeds/policies/
  • https://www.googleapis.com/auth/admin.directory.orgunit
  • https://www.googleapis.com/auth/admin.directory.orgunit.readonly

สำหรับข้อมูลเพิ่มเติม โปรดดูที่คู่มือการให้สิทธิ์

ประเภท

Enum
ALL หน่วยขององค์กรย่อยทั้งหมด
CHILDREN เด็กทันที (ค่าเริ่มต้น)
ALL_INCLUDING_PARENT หน่วยขององค์กรย่อยทั้งหมดและหน่วยขององค์กรที่ระบุ (รูทหากไม่ได้ระบุ)