אחזור רשימה של כל היחידות הארגוניות בחשבון.
בקשת HTTP
GET https://admin.googleapis.com/admin/directory/v1/customer/{customerId}/orgunits
בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
customerId |
המזהה הייחודי של חשבון Google Workspace של הלקוח. כאדמין של חשבון, יש לך אפשרות להשתמש גם בכינוי |
פרמטרים של שאילתה
פרמטרים | |
---|---|
orgUnitPath |
הנתיב המלא ליחידה הארגונית או למזהה הייחודי שלה. מחזירה את הצאצאים של היחידה הארגונית שצוינה. |
type |
אם להחזיר את כל ארגוני המשנה או רק ילדים מיידיים. |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התגובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול נתונים במבנה הבא:
ייצוג JSON |
---|
{
"kind": string,
"etag": string,
"organizationUnits": [
{
object ( |
שדות | |
---|---|
kind |
הסוג של משאב ה-API. למשאבים של יחידה ארגונית, הסוג הוא |
etag |
ETag של המשאב. |
organizationUnits[] |
רשימת אובייקטים של היחידה הארגונית. |
היקפי הרשאות
כדי להשתמש בתכונה הזו יש צורך באחד מההיקפים הבאים של 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 |
כל היחידות הארגוניות המשניות והיחידה הארגונית שצוינה (בסיס אם לא צוין). |