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 כל יחידות המשנה הארגוניות והיחידה הארגונית שצוינה (רמה בסיסית אם לא צוין).