Trước khi gọi Mail Admin Quarantine API, hãy hoàn tất các bước trên trang này để bật API, tìm giá trị nhận dạng mà mọi yêu cầu đều cần và cấp các đặc quyền của quản trị viên cần thiết trong tài khoản Google Workspace của bạn.
Điều kiện tiên quyết
- Tài khoản Google Workspace có tính năng cách ly của quản trị viên. Để tìm hiểu thêm, hãy xem bài viết Thiết lập và quản lý vùng cách ly email.
- Một dự án trên Google Cloud. Để tạo dự án, hãy xem bài viết Tạo dự án.
- Tư cách thành viên trong Chương trình Bản dùng trước cho nhà phát triển của Google Workspace. Dự án trên đám mây của bạn phải được đăng ký tham gia chương trình này thì mới có thể gọi Admin Quarantine API.
- Quyền truy cập vào Bảng điều khiển dành cho quản trị viên của Google với tư cách là quản trị viên cấp cao, để cấp đặc quyền của quản trị viên và uỷ quyền trên toàn miền.
Bật API
Bật mailadminquarantine.googleapis.com trong dự án trên đám mây lưu trữ quy trình tích hợp của bạn.
Giao diện dòng lệnh
Trong Google Cloud Console, hãy bật Mail Admin Quarantine API.
gcloud
Chạy lệnh sau, thay thế PROJECT_ID bằng mã dự án trên đám mây của bạn:
gcloud services enable mailadminquarantine.googleapis.com \
--project=PROJECT_ID
Tìm ID khách hàng của bạn
Mỗi yêu cầu gửi đến API Khu vực cách ly của quản trị viên đều xác định tài khoản Google Workspace của bạn bằng tên tài nguyên customers/CUSTOMER_ID.
Cách tìm mã khách hàng:
- Đăng nhập vào Bảng điều khiển dành cho quản trị viên bằng tài khoản quản trị viên.
- Chuyển đến phần Tài khoản > Cài đặt tài khoản > Hồ sơ.
- Sao chép Mã khách hàng.
Nếu mã khách hàng bắt đầu bằng C, hãy xoá C và sử dụng giá trị chữ và số còn lại trong tên tài nguyên, ví dụ: customers/01abc23de.
Đừng sử dụng tên miền làm mã khách hàng.
Để biết thêm thông tin, hãy xem bài viết Tìm mã khách hàng.
Cấp các đặc quyền của quản trị viên cần thiết
API Khu vực cách ly của quản trị viên thực thi các quy trình kiểm tra đặc quyền của quản trị viên giống như khu vực cách ly của quản trị viên trong Bảng điều khiển dành cho quản trị viên. Mỗi yêu cầu đều được thực hiện thay mặt cho một quản trị viên Google Workspace và quản trị viên đó phải có một trong các đặc quyền sau đây đối với Gmail:
| Vé Đặc quyền | Quyền được cấp |
|---|---|
| Truy cập vào vùng cách ly quản trị | Truy cập và quản lý thư trong tất cả các khu vực cách ly, bao gồm cả khu vực cách ly mặc định. |
| Truy cập vào vùng cách ly bị hạn chế | Chỉ truy cập và quản lý thư trong các khu vực cách ly liên kết với những nhóm mà quản trị viên tham gia. |
Quản trị viên cấp cao tự động có các đặc quyền này. Đối với các quản trị viên khác, hãy chỉ định một vai trò có đặc quyền:
- Đăng nhập vào Bảng điều khiển dành cho quản trị viên bằng tài khoản quản trị viên cấp cao.
- Chuyển đến Tài khoản > Vai trò quản trị.
- Chọn một vai trò hiện có hoặc nhấp vào Tạo vai trò mới.
- Trong thẻ Đặc quyền, hãy chuyển đến phần Dịch vụ > Gmail rồi chọn Truy cập vào vùng cách ly quản trị hoặc Truy cập vào vùng cách ly bị hạn chế.
- Chỉ định vai trò cho tài khoản quản trị viên mà chế độ tích hợp của bạn mạo danh khi gọi API.
Để biết thông tin chi tiết về vai trò quản trị viên được uỷ quyền, hãy xem bài viết Uỷ quyền đặc quyền của quản trị viên trong Gmail và Định nghĩa về đặc quyền của quản trị viên.
Nếu quản trị viên được mạo danh không có đặc quyền cần thiết, thì API sẽ trả về lỗi 403 PERMISSION_DENIED.