REST Resource: users.settings.cse.keypairs

Tài nguyên: CseKeyPair

Cặp khoá S/MIME mã hoá phía máy khách, bao gồm khoá công khai, chuỗi chứng chỉ và siêu dữ liệu cho khoá riêng tư được ghép nối. Gmail sử dụng cặp khoá này để hoàn thành các tác vụ sau:

  • Ký thư gửi đi đã mã hoá phía máy khách.
  • Lưu và mở lại bản nháp của thư đã mã hoá phía máy khách.
  • Lưu và mở lại tin nhắn đã gửi.
  • Giải mã tin nhắn S/MIME đã lưu trữ hoặc đến.
Biểu diễn dưới dạng JSON 
{
  "keyPairId": string,
  "pkcs7": string,
  "pem": string,
  "subjectEmailAddresses": [
    string
  ],
  "enablementState": enum (EnablementState),
  "disableTime": string,
  "privateKeyMetadata": [
    {
      object (CsePrivateKeyMetadata)
    }
  ]
}
Các trường
keyPairId

string

Chỉ có đầu ra. Mã không thể thay đổi cho cặp khoá S/MIME (Phần mở rộng thư Internet an toàn/đa mục đích) mã hoá phía máy khách.
pkcs7

string

Chỉ nhập. Khoá công khai và chuỗi chứng chỉ tương ứng. Chuỗi phải có định dạng PKCS#7, đồng thời sử dụng chế độ mã hoá PEM và bộ giáp ASCII.
pem

string

Chỉ có đầu ra. Khóa công khai và chuỗi chứng chỉ của khóa, ở định dạng PEM.
subjectEmailAddresses[]

string

Chỉ có đầu ra. Thông tin nhận dạng địa chỉ email được chỉ định trên chứng chỉ lá.
enablementState

enum (EnablementState)

Chỉ có đầu ra. Trạng thái hiện tại của cặp khoá.
disableTime

string (Timestamp format)

Chỉ có đầu ra. Nếu bạn đặt một cặp khoá thành DISABLED, thì thời gian mà trạng thái của cặp khoá sẽ thay đổi từ ENABLED thành DISABLED. Trường này chỉ xuất hiện khi cặp khoá ở trạng thái DISABLED.

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".
privateKeyMetadata[]

object (CsePrivateKeyMetadata)

Siêu dữ liệu cho các phiên bản khoá riêng tư của cặp khoá này.

EnablementState

Bảng liệt kê trạng thái hiện tại của cặp khoá.

Enum
stateUnspecified Bạn chưa đặt trạng thái hiện tại của cặp khoá. Cặp khoá không bật/tắt.
enabled

Cặp chìa khoá đang bật. Đối với mọi email mà cặp khoá này mã hoá, Gmail sẽ giải mã thư và ký mọi thư gửi đi bằng khoá riêng tư.

Để bật một cặp khoá, hãy sử dụng phương thức keypairs.enable.
disabled

Cặp khoá bị tắt. Người dùng được xác thực sẽ không thể giải mã email cũng như ký thư gửi đi. Nếu một cặp khoá bị tắt trong hơn 30 ngày, bạn có thể xoá vĩnh viễn cặp khoá đó.

Để tắt một cặp khoá, hãy sử dụng phương thức keypairs.disable.

CsePrivateKeyMetadata

Siêu dữ liệu về thực thể khoá riêng tư.

Biểu diễn dưới dạng JSON 
{
  "privateKeyMetadataId": string,

  // Union field metadata_variant can be only one of the following:
  "kaclsKeyMetadata": {
    object (KaclsKeyMetadata)
  },
  "hardwareKeyMetadata": {
    object (HardwareKeyMetadata)
  }
  // End of list of possible types for union field metadata_variant.
}
Các trường
privateKeyMetadataId

string

Chỉ có đầu ra. Mã không thể thay đổi cho bản sao siêu dữ liệu khoá riêng tư.
Trường nhóm metadata_variant. Trường hợp nhất: Phải có đúng một trong các loại biến thể siêu dữ liệu sau. metadata_variant chỉ có thể là một trong những trạng thái sau đây:
kaclsKeyMetadata

object (KaclsKeyMetadata)

Siêu dữ liệu về một thực thể khoá riêng tư do một dịch vụ danh sách kiểm soát quyền truy cập khoá bên ngoài quản lý.
hardwareKeyMetadata

object (HardwareKeyMetadata)

Siêu dữ liệu về khoá phần cứng.

KaclsKeyMetadata

Siêu dữ liệu về khoá riêng tư do một dịch vụ danh sách kiểm soát quyền truy cập khoá bên ngoài quản lý. Để biết thông tin chi tiết về cách quản lý quyền truy cập khoá, hãy xem Tài liệu tham khảo về API CSE của Google Workspace.

Biểu diễn dưới dạng JSON 
{
  "kaclsUri": string,
  "kaclsData": string
}
Các trường
kaclsUri

string

URI của dịch vụ danh sách kiểm soát quyền truy cập khoá quản lý khoá riêng tư.
kaclsData

string

Dữ liệu mờ do dịch vụ danh sách kiểm soát quyền truy cập khoá tạo ra và sử dụng. Kích thước tối đa: 8 KiB.

HardwareKeyMetadata

Siêu dữ liệu về khoá phần cứng.

Biểu diễn dưới dạng JSON 
{
  "description": string
}
Các trường
description

string

Mô tả về khoá phần cứng.

Phương thức

create

 Tạo và tải chuỗi chứng chỉ khoá công khai S/MIME được mã hoá phía máy khách lên và siêu dữ liệu khoá riêng tư cho người dùng đã xác thực.

disable

 Tắt cặp khoá mã hoá phía máy khách.

enable

 Bật cặp khoá mã hoá phía máy khách đã bị tắt.

get

 Truy xuất cặp khoá mã hoá phía máy khách hiện có.

list

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

obliterate

 Xoá vĩnh viễn và ngay lập tức cặp khoá mã hoá phía máy khách.