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

למידע נוסף, ניתן לעיין במדריך ההרשאות.

תיאור

טיפוסים בני מנייה (enums)
ALL כל היחידות הארגוניות המשניות.
CHILDREN מיידי ילדים בלבד (ברירת מחדל).
ALL_INCLUDING_PARENT כל היחידות הארגוניות המשניות והיחידה הארגונית שצוינה (בסיס אם לא צוין).