המסמך הזה מכיל פרטי אימות והרשאה ספציפיים ל-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 |
היקף לאחזור משאבי יומן בלבד. |