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