Method: users.settings.cse.keypairs.list

Liệt kê các cặp khoá mã hoá phía máy khách cho một người dùng đã xác thực.

Đối với quản trị viên quản lý danh tính và cặp khoá cho người dùng trong tổ chức của họ, các yêu cầu cần được uỷ quyền bằng tài khoản dịch vụ có quyền uỷ quyền trên toàn miền để mạo danh người dùng có phạm vi https://www.googleapis.com/auth/gmail.settings.basic.

Đối với người dùng quản lý danh tính và cặp khoá của riêng họ, các yêu cầu phải bật và định cấu hình mã hoá khoá phần cứng.

Yêu cầu HTTP

GET https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/keypairs

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Thông số
userId

string

Địa chỉ email chính của người yêu cầu. Để chỉ báo người dùng đã được xác thực, bạn có thể sử dụng giá trị đặc biệt me.

Tham số truy vấn

Thông số
pageToken

string

Mã thông báo phân trang cho biết trang cặp khoá nào sẽ được trả về. Nếu bạn không cung cấp mã thông báo, thì API sẽ trả về trang kết quả đầu tiên.
pageSize

integer

Số lượng cặp khoá sẽ trả về. Nếu bạn không cung cấp, kích thước trang sẽ mặc định là 20 mục nhập.

Nội dung yêu cầu

Nội dung yêu cầu phải trống.

Nội dung phản hồi

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "cseKeyPairs": [
    {
      object (CseKeyPair)
    }
  ],
  "nextPageToken": string
}
Trường
cseKeyPairs[]

object (CseKeyPair)

Một trang trong danh sách các cặp khoá CSE đã cài đặt cho người dùng.
nextPageToken

string

Mã thông báo phân trang sẽ được truyền đến lệnh gọi keypairs.list tiếp theo để truy xuất trang tiếp theo của các cặp khoá. Nếu giá trị này không được trả về, thì sẽ không có trang nào khác.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau:

  • https://www.googleapis.com/auth/gmail.settings.basic
  • https://mail.google.com/
  • https://www.googleapis.com/auth/gmail.modify
  • https://www.googleapis.com/auth/gmail.readonly
  • https://www.googleapis.com/auth/gmail.settings.sharing

Để biết thêm thông tin, hãy xem Hướng dẫn uỷ quyền.