Method: orgunits.list

אחזור רשימה של כל היחידות הארגוניות בחשבון.

בקשת HTTP

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

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