Tài liệu này chứa thông tin xác thực và uỷ quyền dành riêng cho API Thư mục. 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 tại bài viết Tìm hiểu về việc xác thực và uỷ quyền.
Định cấu hình OAuth 2.0 để uỷ 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 để bạn có thể phát hành ứng dụng sau này.
Phạm vi API thư mục
Để xác định cấp truy cập được cấp cho ứng dụng, bạn cần xác định và khai báo phạm vi uỷ quyền. Phạm vi uỷ quyền là một chuỗi URI OAuth 2.0 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 của ứng dụng để xử lý dữ liệu Google Workspace, bao gồm cả dữ liệu 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 sử 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 yêu cầu. Người dùng sẵn sàng cấp quyền truy cập vào các phạm vi bị giới hạn và được mô tả rõ ràng hơn.
Directory API 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 trên 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ả các hoạt động trên 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 các tác vụ thực hiện hành động trên thiết bị di động. |
| Phạm vi cho nhóm, bí danh 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ả vai trò của thành viên nhóm và hoạt động thông tin. |
https://www.googleapis.com/auth/admin.directory.group.member.readonly |
Phạm vi chỉ truy xuất vai trò và thông tin của thành viên nhóm. |
https://www.googleapis.com/auth/admin.directory.group |
Phạm vi toàn cục để truy cập vào tất cả các hoạt động của nhóm, bao gồm cả các bí danh 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 về nhóm, bí danh nhóm và thành viên. |
| Phạm vi của đơ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à bí danh người dùng | Ý nghĩa |
https://www.googleapis.com/auth/admin.directory.user |
Phạm vi toàn cục để truy cập vào tất cả các hoạt động của người dùng và bí danh 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 bí danh người dùng. |
https://www.googleapis.com/auth/admin.directory.user.alias |
Phạm vi truy cập vào tất cả thao tác với bí danh người dùng. |
https://www.googleapis.com/auth/admin.directory.user.alias.readonly |
Phạm vi chỉ truy xuất bí danh người dùng. |
| Phạm vi của các tính năng bảo mật dành cho người dùng | Ý nghĩa |
https://www.googleapis.com/auth/admin.directory.user.security |
Phạm vi truy cập vào tất cả các hoạt động liên quan đến mật khẩu, mã xác minh và mã thông báo OAuth dành riêng cho ứng dụng. |
| 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 thao tác 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ê các 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 trên giản đồ người dùng tuỳ chỉnh. |
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ả 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ả thao tác trên miền. |
https://www.googleapis.com/auth/admin.directory.domain.readonly |
Phạm vi chỉ truy xuất miền. |
| Phạm vi cho 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 hoạt động của 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. |