סקירה כללית על Directory API
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
Directory API הוא חלק מ-Admin SDK API מבוסס-RESTful, שאפשר להשתמש בו כדי ליצור ולנהל באופן פרוגרמטי משאבים בשליטת האדמין שנמצאים בבעלות חשבון Google Workspace. הנה כמה תרחישי שימוש:
- יצירה וניהול של משתמשים והוספה של אדמינים.
- יצירה וניהול של קבוצות וחברות בקבוצות.
- מעקב אחרי מכשירים שמחוברים לדומיין וביצוע פעולות במכשירים שאבדו.
- ניהול תרשים ארגוני ומבנים ארגוניים.
- בדיקת האפליקציות שהמשתמשים העניקו להן גישה וביטול הגישה של אפליקציות לא מורשות.
ריכזנו כאן רשימה של מונחים נפוצים שמשמשים ב-Directory API:
- לקוח/ה
- הישות שבבעלותה חשבון Google Workspace, שמיוצגת על ידי משאב הלקוח.
- דומיין
- אם רלוונטי, דומיין ה-DNS שמשויך לחשבון Google Workspace, שמיוצג על ידי משאב הדומיין. לא לכל החשבונות יש דומיין משויך.
- יחידה ארגונית (OU)
- יחידת משנה בעץ הארגוני של חשבון Google Workspace, שמשמשת לקיבוץ ולמיון משתמשים לצורך החלת מדיניות ומתן הרשאות. יחידה ארגונית מיוצגת על ידי המשאב OrgUnit.
- הרשאות
- היכולת של משתמש לבצע פעולה במשאב של Google Workspace.
המידע רלוונטי בעיקר לאדמינים. הרשאה מיוצגת על ידי משאב Privilege.
- תפקיד
- קבוצה מוגדרת של הרשאות שאפשר להקצות למשתמש או לקבוצת משתמשים, שמיוצגת על ידי משאב Role.
- הקצאת תפקיד
- רשומה שמציינת לאיזה משתמש הוקצו תפקידים, ובאיזה היקף.
הקצאת תפקיד מיוצגת על ידי משאב RoleAssignment.
- סכימה
- אובייקט JSON שמגדיר מאפייני משתמש בהתאמה אישית לארגון, שמיוצג על ידי משאב הסכימה.
- משתמש
- חשבון משתמש קצה פרטי עם גישה לאפליקציות ולמשאבים של Google Workspace, שמיוצג על ידי משאב User.
השלבים הבאים
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-08-29 (שעון UTC).
[null,null,["עדכון אחרון: 2025-08-29 (שעון UTC)."],[],[],null,["# Directory API Overview\n\n|-------------------------------------------------------------------------------------------------------------------------------------------|\n| Got 5 minutes? Help us improve our Google Workspace documentation by taking a quick [online survey](https://forms.gle/XcqRP3PJiQv9ADuj9). |\n\nThe Directory API is part of the RESTful Admin SDK API that can be used to\nprogrammatically create and manage admin-controlled resources owned by a\nGoogle Workspace account. Some use cases include:\n\n- Creating and managing users and adding administrators.\n- Creating and managing groups and group memberships.\n- Monitoring devices connected to your domain and taking action on lost devices.\n- Managing your org chart and organization structures.\n- Auditing applications your users have granted access to and revoking unauthorized apps.\n\nFollowing is a list of common terms used in the Directory API:\n\n*Customer*\n: The entity that owns the Google Workspace account, represented by the\n [Customer](/workspace/admin/directory/reference/rest/v1/customers) resource.\n\n*Domain*\n: If applicable, the DNS domain associated with a Google Workspace account,\n represented by the\n [Domain](/workspace/admin/directory/reference/rest/v1/domains) resource. Not all\n accounts have an associated domain.\n\n*Organizational unit (OU)*\n: A sub-unit of a Google Workspace account's organizational tree, used to\n group and sort users for the purpose of applying policies and granting\n authorizations. An OU is represented by the\n [OrgUnit](/workspace/admin/directory/reference/rest/v1/orgunits) resource.\n\n*Privilege*\n: The ability of a user to perform an action on a Google Workspace resource.\n Applies primarily to admins. A privilege is represented by the\n [Privilege](/workspace/admin/directory/reference/rest/v1/privileges/list#Privilege)\n resource.\n\n*Role*\n: A defined collection of privileges that can be assigned to a user or set of\n users, represented by the\n [Role](/workspace/admin/directory/reference/rest/v1/roles) resource.\n\n*Role assignment*\n: A record indicating which user is granted what roles, and over what scope.\n A role assignment is represented by the\n [RoleAssignment](/workspace/admin/directory/reference/rest/v1/roleAssignments)\n resource.\n\n*Schema*\n: A JSON object that defines custom user attributes for your organization,\n represented by the\n [Schema](/workspace/admin/directory/reference/rest/v1/schemas) resource.\n\n*User*\n: An individual end user account with access to Google Workspace apps and\n resources, represented by the\n [User](/workspace/admin/directory/reference/rest/v1/users) resource.\n\nNext steps\n----------\n\n- To learn about developing with Google Workspace APIs, including handling\n authentication and authorization, refer to\n [Get started as a Workspace developer](/workspace/guides/getstarted-overview).\n\n- To learn how to configure and run a simple Directory API app, try the\n [JavaScript quickstart](/workspace/admin/directory/v1/quickstart/js)."]]
