המסמך הזה מכיל מידע על הרשאה ואימות ספציפיים ל-Directory API. לפני קריאת המסמך הזה, חשוב לקרוא את המידע הכללי על אימות והרשאה ב-Google Workspace במאמר מידע על אימות והרשאה.
הגדרת OAuth 2.0 להרשאה
מגדירים את מסך ההסכמה של OAuth ובוחרים היקפי הרשאה כדי לקבוע איזה מידע יוצג למשתמשים ולבודקים של האפליקציה, ומרשמים את האפליקציה כדי שתוכלו לפרסם אותה בהמשך.
היקפי הרשאות של Directory API
כדי להגדיר את רמת הגישה שמוענקת לאפליקציה, צריך לזהות ולדווח על היקפי הרשאה. היקף הרשאה הוא מחרוזת URI של OAuth 2.0 שמכילה את שם האפליקציה ב-Google Workspace, את סוג הנתונים שהיא ניגשת אליהם ואת רמת הגישה. היקפים הם הבקשות של האפליקציה לעבוד עם נתוני Google Workspace, כולל נתונים מחשבון Google של המשתמשים.
כשהאפליקציה מותקנת, המשתמש מתבקש לאמת את ההיקפים שבהם האפליקציה משתמשת. באופן כללי, כדאי לבחור את ההיקף המצומצם ביותר האפשרי ולהימנע מבקשות להיקפים שלא נדרשים לאפליקציה. משתמשים נותנים גישה בקלות רבה יותר להיקפים מוגבלים ומתוארים בבירור.
Directory API תומך בהיקפים הבאים:
| היקפים למכשירים | משמעות |
|---|---|
https://www.googleapis.com/auth/admin.directory.device.chromeos |
היקף גלובלי לגישה לכל הפעולות במכשיר Chrome. |
https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly |
היקף לאחזור מכשירי Chrome בלבד. |
https://www.googleapis.com/auth/admin.directory.device.mobile |
היקף גלובלי לגישה לכל הפעולות במכשירים ניידים. |
https://www.googleapis.com/auth/admin.directory.device.mobile.readonly |
היקף לאחזור מכשיר נייד בלבד |
https://www.googleapis.com/auth/admin.directory.device.mobile.action |
היקף של משימות שמבצעות פעולה במכשיר נייד. |
| היקפים לקבוצות, לכינויים של קבוצות ולחברים בקבוצות | משמעות |
https://www.googleapis.com/auth/admin.directory.group.member |
היקף הגישה לכל התפקידים של חברי הקבוצה ולפעולות המידע. |
https://www.googleapis.com/auth/admin.directory.group.member.readonly |
היקף לאחזור רק את התפקידים והפרטים של חברי הקבוצה. |
https://www.googleapis.com/auth/admin.directory.group |
היקף גלובלי לגישה לכל פעולות הקבוצה, כולל כינויים של קבוצות וחברים בקבוצות. |
https://www.googleapis.com/auth/admin.directory.group.readonly |
היקף לאחזור רק של פרטי הקבוצה, כתובת האימייל החלופית של הקבוצה וחברי הקבוצה. |
| היקפים של יחידות ארגוניות | משמעות |
https://www.googleapis.com/auth/admin.directory.orgunit |
היקף גלובלי לגישה לכל הפעולות של היחידות הארגוניות. |
https://www.googleapis.com/auth/admin.directory.orgunit.readonly |
היקף לאחזור יחידות ארגוניות בלבד. |
| היקפי הרשאות למשתמשים וכתובות אימייל חלופיות של משתמשים | משמעות |
https://www.googleapis.com/auth/admin.directory.user |
היקף גלובלי לגישה לכל הפעולות של משתמשים ושל כתובות אימייל חלופיות של משתמשים. |
https://www.googleapis.com/auth/admin.directory.user.readonly |
היקף לאחזור משתמשים או כתובות אימייל חלופיות של משתמשים בלבד. |
https://www.googleapis.com/auth/admin.directory.user.alias |
היקף הגישה לכל הפעולות של כתובות אימייל חלופיות של משתמשים. |
https://www.googleapis.com/auth/admin.directory.user.alias.readonly |
היקף לאחזור כינויים של משתמשים בלבד. |
| היקפים של תכונות אבטחה של משתמשים | משמעות |
https://www.googleapis.com/auth/admin.directory.user.security |
היקף הגישה לכל הפעולות שקשורות לסיסמאות, לאסימוני OAuth ולקודי אימות ספציפיים לאפליקציה. |
| היקפים לניהול תפקידים | משמעות |
https://www.googleapis.com/auth/admin.directory.rolemanagement |
ההיקף של כל פעולות ניהול התפקידים, כולל יצירת תפקידים והקצאות תפקידים. |
https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly |
היקף של אחזור ורישום של תפקידים, הרשאות והקצאות תפקידים. |
| היקפים של סכימות משתמשים בהתאמה אישית | משמעות |
https://www.googleapis.com/auth/admin.directory.userschema |
היקף הגישה לכל הפעולות בהתאמה אישית של סכימת משתמשים. |
https://www.googleapis.com/auth/admin.directory.userschema.readonly |
היקף לאחזור רק של סכמות משתמשים בהתאמה אישית. |
| היקפי הרשאות ללקוחות | משמעות |
https://www.googleapis.com/auth/admin.directory.customer |
היקף הגישה לכל הפעולות של הלקוח. |
https://www.googleapis.com/auth/admin.directory.customer.readonly |
היקף להצגת לקוחות בלבד. |
| היקפים לדומיינים | משמעות |
https://www.googleapis.com/auth/admin.directory.domain |
היקף הגישה לכל פעולות הדומיין. |
https://www.googleapis.com/auth/admin.directory.domain.readonly |
היקף לאחזור דומיינים בלבד. |
| היקפים של משאבים לתזמון ביומן | משמעות |
https://www.googleapis.com/auth/admin.directory.resource.calendar |
היקף הגישה לכל הפעולות של משאבי היומן. |
https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly |
היקף לאחזור רק משאבי יומן. |