Tài liệu này chứa thông tin xác thực và uỷ quyền dành riêng cho Directory API. Trước khi đọc tài liệu này, hãy nhớ đọc thông tin chung về việc xác thực và uỷ quyền của Google Workspace trong bài viết Tìm hiểu về quy trình xác thực và uỷ quyền.
Định cấu hình OAuth 2.0 để ủy quyền
Định cấu hình màn hình xin phép bằng OAuth và chọn phạm vi để xác định thông tin nào sẽ hiển thị cho người dùng và người đánh giá ứng dụng, đồng thời đăng ký ứng dụng của bạn để bạn có thể phát hành sau.
Phạm vi API Thư mục
Để xác định cấp truy cập được cấp cho ứng dụng của mình, bạn cần xác định và khai báo phạm vi cấp quyền. Phạm vi uỷ quyền là một chuỗi URI OAuth 2.0 có chứa tên ứng dụng Google Workspace, loại dữ liệu mà ứng dụng đó truy cập và cấp truy cập. Phạm vi là các yêu cầu mà ứng dụng của bạn yêu cầu để hoạt động với dữ liệu Google Workspace, bao gồm cả dữ liệu trong Tài khoản Google của người dùng.
Khi cài đặt ứng dụng, người dùng sẽ được yêu cầu xác thực các phạm vi mà ứng dụng dùng. Nhìn chung, bạn nên chọn phạm vi tập trung hẹp nhất có thể và tránh yêu cầu các phạm vi mà ứng dụng không cần. Người dùng dễ dàng cấp quyền truy cập vào các phạm vi giới hạn, được mô tả rõ ràng.
API thư mục hỗ trợ các phạm vi sau:
| Phạm vi cho thiết bị | Ý nghĩa |
|---|---|
https://www.googleapis.com/auth/admin.directory.device.chromeos |
Phạm vi toàn cầu để truy cập vào tất cả các hoạt động của thiết bị Chrome. |
https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly |
Phạm vi chỉ truy xuất các thiết bị Chrome. |
https://www.googleapis.com/auth/admin.directory.device.mobile |
Phạm vi toàn cầu để truy cập vào tất cả hoạt động của thiết bị di động. |
https://www.googleapis.com/auth/admin.directory.device.mobile.readonly |
Phạm vi chỉ truy xuất thiết bị di động |
https://www.googleapis.com/auth/admin.directory.device.mobile.action |
Phạm vi cho những tác vụ thực hiện hành động trên thiết bị di động. |
| Phạm vi cho nhóm, email đại diện của nhóm và thành viên nhóm | Ý nghĩa |
https://www.googleapis.com/auth/admin.directory.group.member |
Phạm vi truy cập vào tất cả các vai trò của thành viên trong nhóm và các thao tác thông tin. |
https://www.googleapis.com/auth/admin.directory.group.member.readonly |
Phạm vi chỉ truy xuất thông tin và vai trò của thành viên nhóm. |
https://www.googleapis.com/auth/admin.directory.group |
Phạm vi toàn cầu để truy cập vào tất cả các hoạt động của nhóm, bao gồm cả email đại diện và thành viên của nhóm. |
https://www.googleapis.com/auth/admin.directory.group.readonly |
Phạm vi chỉ truy xuất thông tin nhóm, bí danh nhóm và thành viên. |
| Phạm vi cho đơn vị tổ chức | Ý nghĩa |
https://www.googleapis.com/auth/admin.directory.orgunit |
Phạm vi toàn cầu để truy cập vào tất cả hoạt động của đơn vị tổ chức. |
https://www.googleapis.com/auth/admin.directory.orgunit.readonly |
Phạm vi chỉ truy xuất các đơn vị tổ chức. |
| Phạm vi cho người dùng và email đại diện của người dùng | Ý nghĩa |
https://www.googleapis.com/auth/admin.directory.user |
Phạm vi chung để truy cập vào tất cả các thao tác của người dùng và email đại diện của người dùng. |
https://www.googleapis.com/auth/admin.directory.user.readonly |
Phạm vi chỉ truy xuất người dùng hoặc email đại diện của người dùng. |
https://www.googleapis.com/auth/admin.directory.user.alias |
Phạm vi truy cập vào tất cả các thao tác đại diện của người dùng. |
https://www.googleapis.com/auth/admin.directory.user.alias.readonly |
Phạm vi chỉ truy xuất email đại diện của người dùng. |
| Phạm vi cho các tính năng bảo mật người dùng | Ý nghĩa |
https://www.googleapis.com/auth/admin.directory.user.security |
Phạm vi truy cập tất cả các thao tác liên quan đến mật khẩu dành riêng cho ứng dụng, mã thông báo OAuth và mã xác minh. |
| Phạm vi quản lý vai trò | Ý nghĩa |
https://www.googleapis.com/auth/admin.directory.rolemanagement |
Phạm vi cho tất cả các hoạt động quản lý vai trò, bao gồm cả việc tạo vai trò và chỉ định vai trò. |
https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly |
Phạm vi nhận và liệt kê vai trò, đặc quyền và chỉ định vai trò. |
| Phạm vi cho giản đồ người dùng tuỳ chỉnh | Ý nghĩa |
https://www.googleapis.com/auth/admin.directory.userschema |
Phạm vi truy cập vào tất cả các thao tác tuỳ chỉnh trong giản đồ người dùng. |
https://www.googleapis.com/auth/admin.directory.userschema.readonly |
Phạm vi chỉ truy xuất giản đồ người dùng tuỳ chỉnh. |
| Phạm vi cho khách hàng | Ý nghĩa |
https://www.googleapis.com/auth/admin.directory.customer |
Phạm vi truy cập vào tất cả các hoạt động của khách hàng. |
https://www.googleapis.com/auth/admin.directory.customer.readonly |
Phạm vi chỉ truy xuất khách hàng. |
| Phạm vi cho miền | Ý nghĩa |
https://www.googleapis.com/auth/admin.directory.domain |
Phạm vi truy cập vào tất cả các hoạt động của miền. |
https://www.googleapis.com/auth/admin.directory.domain.readonly |
Phạm vi chỉ truy xuất miền. |
| Phạm vi của tài nguyên lịch | Ý nghĩa |
https://www.googleapis.com/auth/admin.directory.resource.calendar |
Phạm vi truy cập vào tất cả các thao tác đối với tài nguyên lịch. |
https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly |
Phạm vi chỉ truy xuất tài nguyên lịch. |