דף זה תורגם על ידי Cloud Translation API.

Directory API: יחידות ארגוניות

ניהול יחידות ארגוניות

העץ הארגוני של חשבון Google Workspace מורכב מיחידות ארגוניות שמאפשרות לנהל את המשתמשים במבנה לוגי והיררכי. הדבר דומה לפונקציונליות שמופיעה בדף 'ארגונים ומשתמשים' במסוף Admin . היררכיית היחידה הארגונית של הלקוח מוגבלת ל-35 רמות עומק. מידע נוסף זמין במרכז העזרה לאדמינים.

לכל חשבון Google Workspace יש רק עץ ארגון אחד. כשמגדירים את החשבון הזה בפעם הראשונה, יש לו יחידה ארגונית ברמת החשבון. הארגון שמשויך לדומיין הראשי. כאן אפשר לקרוא מידע נוסף על הדומיין הראשי.
שם הנתיב של יחידה ארגונית הוא ייחודי. יכול להיות שהשם של היחידה הארגונית לא יהיה ייחודי בהיררכיה של הארגון, אבל השם שלה ייחודי בין היחידות הארגוניות ואחיות שלה. ושם היחידה הארגונית לא תלוי אותיות רישיות (case-sensitive).
יחידה ארגונית יורשת את כללי המדיניות מההיררכיה הארגונית. כל ארגון יחידה יכולה לחסום את השרשרת הזו של ירושה של הורה על ידי ביטול המדיניות שעברה בירושה. קדימות של מדיניות אחת על אחרת נקבעת על ידי היחידה הארגונית הקרובה ביותר. כלומר, כללי מדיניות של יחידה ארגונית נמוכה יותר יכולים לקבל עדיפות על פני כללי המדיניות של יחידות הורה גבוהות יותר. ההגדרה blockInheritance מאפשרת ירושה של הגדרת החסימה: יחידה ארגונית וארגון המשנה שלה. האפשרות blockInheritance הוצאה משימוש. אין יותר תמיכה בהגדרה הזו כ-'TRUE' ויכולות להיות לה השלכות לא מכוונות. עבור למידע נוסף על ירושה ומשתמשים במבנה ארגוני, ראו את מרכז העזרה לאדמינים.
ניתן להעביר יחידה ארגונית למעלה או למטה בעץ היררכי. בנוסף, אפשר להעביר את המשתמשים המשויכים לארגון בנפרד או בבת אחת, כשמאכלסים ארגון חדש או מעבירים קבוצת משנה של משתמשים מיחידה ארגונית אחת לאחרת.
הנתונים שנשמרים בנכסים של היחידה הארגונית יכולים להשתנות כל הזמן. כששולחים בקשה, הנכסים שהוחזרו לישות יהיו עקביים בזמן האחזור של הישות.כלומר, לא תראו את המילה 'חלקי' אם פעולת אחזור מחזירה יותר מישות אחת, אין ערובה לעקביות בין הישויות.זה נכון במיוחד כשהתשובה מתפרסת על פני מספר דפים בעימוד.

יצירת יחידה ארגונית

כדי ליצור יחידה ארגונית, צריך להשתמש בבקשת POST הבאה ולכלול את ההרשאה שמתוארת בקטע בקשות הרשאה.

אדמינים שיוצרים יחידה ארגונית יכולים להשתמש ב-my_customer.

POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer/orgunits

אם את/ה מפיץ/ה ליצור יחידה ארגונית ללקוח שקנה דרך מפיץ, צריך להשתמש ב-customerId. כדי לאחזר את customerId, משתמשים בפעולה אחזור משתמש.

POST https://admin.googleapis.com/admin/directory/v1/customer/customerId/orgunits

כדי להבין את מבנה הארגון בחשבון, אפשר לעיין במרכז העזרה לאדמינים. למאפיינים של בקשות ותגובה, ראו הפניית API.

בקשת JSON

בדוגמה הבאה של מפיץ JSON מוצג גוף בקשה לדוגמה שיוצר את היחידה הארגונית sales_support. השדות name וparentOrgUnitPath הם שדות חובה:

POST https://admin.googleapis.com/admin/directory/v1/customer/C03az79cb/orgunits

{
    "name": "sales_support",
    "description": "The sales support team",
    "parentOrgUnitPath": "/corp/support",
    "blockInheritance": false
}

תגובת JSON

תגובה מוצלחת תחזיר קוד סטטוס HTTP 201. יחד עם קוד הסטטוס, התגובה תחזיר את המאפיינים של הקבוצה החדשה:

{
    "kind": "directory#orgUnit",
    "name": "sales_support",
    "description": "The sales support team",
    "orgUnitPath": "/corp/support/sales_support",
    "parentOrgUnitPath": "/corp/support",
    "blockInheritance": false
  }

עדכון של יחידה ארגונית

כדי לעדכן יחידה ארגונית, צריך להשתמש בבקשת PUT הבאה ולכלול את ההרשאה שמתוארת בקטע בקשות הרשאה. למאפיינים של הבקשה והתגובה, עיינו בהפניה ל-API:

אדמינים שמעדכנים יחידה ארגונית יכולים להשתמש ב-my_customer.

 PUT https://admin.googleapis.com/admin/directory/v1/customer/my_customer/orgunits/orgUnitPath

אם את/ה מפיץ/ה שמעדכן יחידה ארגונית של לקוח שקנה דרך מפיץ, צריך להשתמש ב-customerId. כדי לקבל את הפונקציה customerId, משתמשים בפעולה אחזור משתמש.

PUT https://admin.googleapis.com/admin/directory/v1/customer/customerId/orgunits/orgUnitPath

בקשת JSON

בדוגמה הבאה, תיאור היחידה הארגונית עודכן:

PUT https://admin.googleapis.com/admin/directory/v1/customer/my_customer/orgunits/corp/support/sales_support

{
    "description": "The BEST sales support team"
}

הערות לבקשת עדכון:

צריך לשלוח רק את המידע המעודכן בבקשה. אתם לא צריכים להזין את כל מאפייני הקבוצה בבקשה.
אם משתמש לא הוקצה ליחידה ארגונית מסוימת כשחשבון המשתמש נוצר, החשבון נמצא ביחידה הארגונית שברמה העליונה.
אפשר להעביר יחידה ארגונית לחלק אחר במבנה הארגון של החשבון על ידי הגדרת הנכס parentOrgUnitPath בבקשה. חשוב לציין שהעברה של יחידה ארגונית יכולה לשנות את השירותים וההגדרות עבור המשתמשים ביחידה הארגונית שמועברת.

תגובת JSON

תגובה מוצלחת תחזיר קוד סטטוס HTTP 201. יחד עם קוד הסטטוס, התשובה תחזיר את המאפיינים של היחידה הארגונית המעודכנת.

{
    "kind": "directory#orgUnit",
    "name": "sales_support",
    "description": "The BEST sales support team",
    "orgUnitPath": "/corp/support/sales_support",
    "parentOrgUnitPath": "/corp/support",
    "blockInheritance": false
}

אם משתמש לא הוקצה ליחידה ארגונית מסוימת כשחשבון המשתמש נוצר, החשבון נמצא ביחידה הארגונית שברמה העליונה. היחידה הארגונית של המשתמש קובעת לאילו שירותי Google Workspace למשתמש תהיה גישה. אם המשתמש מועבר לארגון חדש, הגישה של המשתמש משתנה. למידע נוסף על מבני ארגונים, ניתן להיכנס למרכז העזרה בנושא ניהול. למידע נוסף על העברת משתמש לארגון אחר, ראו עדכון משתמש.

אחזור של יחידה ארגונית

כדי לאחזר יחידה ארגונית, צריך להשתמש בבקשת GET הבאה ולכלול את ההרשאה שמתוארת בקטע בקשות הרשאה. מחרוזת השאילתה orgUnitPath היא הנתיב המלא של היחידה הארגונית הזו. למאפיינים של הבקשה והתגובה, עיינו בהפניה ל-API:

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

GET https://admin.googleapis.com/admin/directory/v1/customer/my_customer/orgunits/orgUnitPath

מפיץ שמאחזר יחידה ארגונית של לקוח שקנה דרך מפיץ יכול להשתמש בcustomerId. כדי לקבל את הפעולה customerId, משתמשים בפעולה אחזור משתמש.

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

תגובת JSON

בדוגמה הבאה, העמודה 'מכירות בשירות חיוני' בוצע אחזור של היחידה הארגונית. חשוב לשים לב ל-'Frontline+sales' קידוד HTTP ב-URI של הבקשה:

GET https://admin.googleapis.com/admin/directory/v1/customer/my_customer/orgunits/corp/sales/frontline+sales

תגובה מוצלחת תחזיר קוד סטטוס HTTP 200. יחד עם קוד הסטטוס, התשובה תחזיר את ההגדרות של היחידה הארגונית:

{
    "kind": "directory#orgUnit",
    "name": "frontline sales",
    "description": "The frontline sales team",
    "orgUnitPath": "/corp/sales/frontline sales",
    "parentOrgUnitPath": "/corp/sales",
    "blockInheritance": false
}

אחזור יחידות ארגוניות

כדי לאחזר את כל היחידות הארגוניות המשניות ביחידה ארגונית, את הצאצאים המיידיים ביחידה הארגונית, או את כל היחידות הארגוניות המשניות וכן היחידה הארגונית שצוינה, משתמשים בבקשת GET הבאה וכוללים את ההרשאה שמתוארת בבקשות הרשאה. למאפיינים של הבקשה והתגובה, ראו הפניית API.

אדמינים של חשבון שמאחזרים את כל יחידות המשנה הארגוניות יכולים להשתמש ב-my_customer. כדי לשפר את הקריאוּת, בדוגמה הזו אנחנו מחזירים שורות:

GET https://admin.googleapis.com/admin/directory/v1/customer/my_customer
/orgunits?orgUnitPath=full org unit path&type=all or children or all_including_parent

מפיץ שמאחזר יחידות ארגוניות של לקוח שקנה דרך מפיץ, יכול להשתמש בcustomerId. כדי לקבל את הפעולה customerId, משתמשים בפעולה אחזור משתמש:

GET https://admin.googleapis.com/admin/directory/v1/customer/customerId
/orgunits?orgUnitPath=full org unit path&type=all or children or all_including_parent

מחרוזת השאילתה get מחזירה all יחידות משנה ארגוניות מתחת ל-orgUnitPath, את ה-children המיידי מתוך orgUnitPath, או את כל היחידות הארגוניות המשניות ואת orgUnitPath שצוין עבור all_including_parent. ערך ברירת המחדל הוא type=children.

תגובת JSON

לדוגמה, הבקשה הזו תחזיר את כל היחידות הארגוניות החל מהיחידה הארגונית /corp:

GET https://admin.googleapis.com/admin/directory/v1/customer/my_customer/orgunits?orgUnitPath=/corp&type=all

תגובה מוצלחת תחזיר קוד סטטוס HTTP 200. יחד עם קוד הסטטוס, התשובה תחזיר את היחידות הארגוניות של החשבון:

{
"kind": "directory#orgUnits",
    "organizationUnits": [
     {
    "kind": "directory#orgUnit",
    "name": "sales",
    "description": "The corporate sales team",
    "orgUnitPath": "/corp/sales",
    "parentOrgUnitPath": "/corp",
    "blockInheritance": false
     },
     {
    "kind": "directory#orgUnit",
    "name": "frontline sales",
    "description": "The frontline sales team",
    "orgUnitPath": "/corp/sales/frontline sales",
    "parentOrgUnitPath": "/corp/sales",
    "blockInheritance": false
     },
     {
    "kind": "directory#orgUnit",
    "name": "support",
    "description": "The corporate support team",
    "orgUnitPath": "/corp/support",
    "parentOrgUnitPath": "/corp",
    "blockInheritance": false
     },
     {
    "kind": "directory#orgUnit",
    "name": "sales_support",
    "description": "The BEST support team",
    "orgUnitPath": "/corp/support/sales_support",
    "parentOrgUnitPath": "/corp/support",
    "blockInheritance": false
     }
  ]
  }

מחיקה של יחידה ארגונית

כדי למחוק יחידה ארגונית, צריך להשתמש בבקשת DELETE הבאה ולכלול את ההרשאה שמתוארת בקטע בקשות הרשאה. כדי לאחזר את customerId, משתמשים בפעולה אחזור משתמש. למאפיינים של הבקשה והתגובה, עיינו בהפניה ל-API:

אדמינים של חשבון שמוחקים יחידה ארגונית יכולים להשתמש ב-my_customer.

DELETE https://admin.googleapis.com/admin/directory/v1/customer/my_customer/orgunits/orgUnitPath

אם אתה מפיץ שמוחק יחידה ארגונית של לקוח שקנה דרך מפיץ, אפשר להשתמש ב-customerId. כדי לקבל את הפעולה customerId, משתמשים בפעולה אחזור משתמש.

DELETE https://admin.googleapis.com/admin/directory/v1/customer/customerId/orgunits/orgUnitPath

לדוגמה, בקשת DELETE של המפיץ הזה מוחקת את 'backend_tests' יחידה ארגונית:

DELETE https://admin.googleapis.com/admin/directory/v1/customer/C03az79cb/orgunits/corp/sales/backend_tests

תגובה מוצלחת תחזיר קוד סטטוס HTTP 200.

אפשר למחוק רק יחידות ארגוניות שלא הוקצו להן יחידות צאצא ארגוניות או משתמשים אחרים. לפני המחיקה, צריך להקצות מחדש את המשתמשים ליחידות ארגוניות אחרות ולהסיר את כל יחידות הצאצא הארגוניות.