این سند حاوی اطلاعات مجوز و احراز هویت خاص Directory API است. قبل از خواندن این سند، حتماً اطلاعات عمومی احراز هویت و مجوز Google Workspace را در اطلاعات مربوط به احراز هویت و مجوز مطالعه کنید.
OAuth 2.0 را برای مجوز پیکربندی کنید
صفحه رضایت OAuth را پیکربندی کنید و دامنه ها را انتخاب کنید تا مشخص کنید چه اطلاعاتی برای کاربران و بازبینان برنامه نمایش داده می شود و برنامه خود را ثبت کنید تا بتوانید بعداً آن را منتشر کنید.
حوزه های API دایرکتوری
برای تعریف سطح دسترسی اعطا شده به برنامه خود، باید محدوده های مجوز را شناسایی و اعلام کنید. محدوده مجوز یک رشته URI OAuth 2.0 است که حاوی نام برنامه Google Workspace، نوع داده‌هایی است که به آن دسترسی دارد و سطح دسترسی. Scopes درخواست‌های برنامه شما برای کار با داده‌های 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 | محدوده فقط برای بازیابی منابع تقویم. |