Directory API הוא חלק מ-Admin SDK API מבוסס RESTful, שבעזרתו אפשר ליצור ולנהל באופן פרוגרמטי משאבים בשליטת האדמין שנמצאים בבעלות חשבון Google Workspace. הנה כמה תרחישי שימוש:
- יצירה וניהול של משתמשים והוספה של אדמינים.
- יצירה וניהול של קבוצות וחברות בקבוצות.
- מעקב אחרי מכשירים שמחוברים לדומיין וביצוע פעולות במכשירים שאבדו.
- ניהול תרשים ארגוני ומבנים ארגוניים.
- ביקורת על אפליקציות שהמשתמשים העניקו להן גישה וביטול של אפליקציות לא מורשות.
בהמשך מופיעה רשימה של מונחים נפוצים שמשמשים ב-Directory API:
- לקוח
- הישות שבבעלותה חשבון Google Workspace, שמיוצגת על ידי משאב הלקוח.
- דומיין
- אם רלוונטי, דומיין ה-DNS שמשויך לחשבון Google Workspace, שמיוצג על ידי משאב Domain. לא לכל החשבונות יש דומיין משויך.
- יחידה ארגונית (OU)
- יחידת משנה בעץ הארגוני של חשבון Google Workspace, שמשמשת לקיבוץ ולמיון משתמשים לצורך החלת מדיניות ומתן הרשאות. יחידה ארגונית מיוצגת על ידי משאב OrgUnit.
- הרשאות
- היכולת של משתמש לבצע פעולה במשאב של Google Workspace. המידע רלוונטי בעיקר לאדמינים. הרשאה מיוצגת על ידי משאב Privilege.
- תפקיד
- קבוצה מוגדרת של הרשאות שאפשר להקצות למשתמש או לקבוצת משתמשים, שמיוצגת על ידי משאב התפקיד.
- הקצאת תפקידים
- רשומה שמציינת לאיזה משתמש הוקצו תפקידים, ובאיזה היקף. הקצאת תפקיד מיוצגת על ידי משאב RoleAssignment.
- סכימה
- אובייקט JSON שמגדיר מאפייני משתמש בהתאמה אישית לארגון, שמיוצגים על ידי משאב הסכימה.
- משתמש
- חשבון משתמש פרטי עם גישה לאפליקציות ולמשאבים של Google Workspace, שמיוצג על ידי משאב User.
השלבים הבאים
כדי לקבל מידע על פיתוח באמצעות ממשקי API של Google Workspace, כולל טיפול באימות ובמתן הרשאות, אפשר לעיין במאמר תחילת העבודה כמפתחים ב-Workspace.
כדי ללמוד איך להגדיר ולהריץ אפליקציה של Directory API, אפשר לנסות את המדריך למתחילים בנושא JavaScript.