Tổng quan về Mail Admin Quarantine API

Mail Admin Quarantine API cho phép quản trị viên Google Workspace quản lý theo chương trình các nội dung email mà Gmail lưu giữ trong vùng cách ly của quản trị viên. Thư sẽ được đưa vào khu vực cách ly khi khớp với các quy tắc tuân thủ, ngăn chặn mất dữ liệu (DLP) hoặc bảo mật mà bạn thiết lập trong Bảng điều khiển dành cho quản trị viên của Google.

Sử dụng API để xây dựng các quy trình tự động hoá về bảo mật và tuân thủ, chẳng hạn như:

  • Truy xuất thư bị cách ly vào nền tảng SIEM hoặc SOAR để phân loại.
  • Xem xét tiêu đề thư, đoạn nội dung và tệp đính kèm trước khi quyết định cách xử lý thư.
  • Phát hành thư an toàn và từ chối thư không an toàn, riêng lẻ hoặc theo lô tối đa 500 thư.

Các tài nguyên chính

Admin Quarantine API hiển thị các tài nguyên sau đây trong một khách hàng:

Tài nguyên Tên tài nguyên Mô tả
Khách hàng customers/CUSTOMER_ID Tài khoản Google Workspace của bạn. Để biết thông tin chi tiết, hãy xem bài viết Tìm mã khách hàng.
customers.quarantinedMessages customers/CUSTOMER_ID/quarantinedMessages/MESSAGE_OWNER:MESSAGE_ID Nội dung email bị giữ trong vùng cách ly. MESSAGE_OWNER là địa chỉ email của chủ sở hữu hộp thư và MESSAGE_ID là mã thư không thể thay đổi trong Gmail.
customers.quarantines customers/CUSTOMER_ID/quarantines/QUARANTINE_ID Khu vực cách ly mà bạn đã thiết lập trong Bảng điều khiển dành cho quản trị viên.
customers.operations customers/CUSTOMER_ID/operations/OPERATION_ID Một thao tác chạy trong thời gian dài để theo dõi yêu cầu phát hành hàng loạt hoặc từ chối hàng loạt.

QuarantinedMessage chứa một trong các đối tượng State sau:

Tiểu bang Mô tả
PENDING_TRIAGE Thư được giữ trong vùng cách ly và chờ quản trị viên quyết định.
RELEASED Quản trị viên đã phát hành thư và Gmail đã gửi thư đó.
DENIED Quản trị viên đã từ chối thư và Gmail đã loại bỏ thư đó.

Phương thức

Tất cả yêu cầu đều nhắm đến https://mailadminquarantine.googleapis.com/v1.

Phương thức Yêu cầu HTTP Mô tả
customers.quarantinedMessages.list GET /customers/*/quarantinedMessages Liệt kê các thư bị cách ly trong 30 ngày qua.
customers.quarantinedMessages.search POST /customers/*/quarantinedMessages:search Tìm kiếm thư bị cách ly bằng bộ lọc hoặc cụm từ tìm kiếm trong Gmail.
customers.quarantinedMessages.get GET /customers/*/quarantinedMessages/* Lấy siêu dữ liệu, nội dung được phân tích cú pháp hoặc thư RFC 2822 thô.
customers.quarantinedMessages.release POST /customers/*/quarantinedMessages/*:release Phát hành một thư để gửi.
customers.quarantinedMessages.deny POST /customers/*/quarantinedMessages/*:deny Từ chối một tin nhắn.
customers.quarantinedMessages.batchRelease POST /customers/*/quarantinedMessages:batchRelease Phát hành không đồng bộ tối đa 500 thông báo.
customers.quarantinedMessages.batchDeny POST /customers/*/quarantinedMessages:batchDeny Từ chối không đồng bộ tối đa 500 thư.
customers.operations.get GET /customers/*/operations/* Lấy trạng thái và kết quả của một thao tác hàng loạt.
customers.quarantines.list GET /customers/*/quarantines Liệt kê các chế độ cách ly được định cấu hình cho khách hàng.
customers.quarantines.get GET /customers/*/quarantines/* Lấy tên hiển thị và nội dung mô tả của một thư mục cách ly.

Các bước triển khai cấp cao

  1. Thiết lập API: tham gia Chương trình Bản dùng trước cho nhà phát triển, bật API trong dự án trên đám mây của Google Cloud, tìm mã khách hàng và cấp đặc quyền của quản trị viên cần thiết.
  2. Uỷ quyền bằng tính năng uỷ quyền trên toàn miền: tạo một tài khoản dịch vụ, định cấu hình tính năng uỷ quyền trên toàn miền bằng phạm vi của Admin Quarantine API và lấy mã truy cập mạo danh một quản trị viên.
  3. Sắp xếp tin nhắn:
    1. Liệt kê và tìm kiếm thư bị cách ly.
    2. Xem thông tin chi tiết về tin nhắn.
    3. Cho phép gửi hoặc từ chối một thư, hoặc cho phép gửi hoặc từ chối thư theo lô.
  4. Tuân thủ hạn mức sử dụng.

Ghi nhật ký kiểm tra

Mỗi lệnh gọi API đọc hoặc thay đổi thư bị cách ly đều được ghi lại trong nhật ký kiểm tra và điều tra của Bảng điều khiển dành cho quản trị viên, được gán cho quản trị viên mà yêu cầu chạy dưới danh nghĩa.

Các bước tiếp theo