REST Resource: users.settings.cse.keypairs

Tài nguyên: CseKeyPair

Cặp khoá S/MIME được mã hoá phía máy khách, bao gồm một 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ý các thư được mã hoá phía máy khách gửi đi.
  • Lưu và mở lại bản nháp của thư được mã hoá phía máy khách.
  • Lưu và mở lại các thư đã gửi.
  • Giải mã thư S/MIME đến hoặc đã được lưu trữ.
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)
    }
  ]
}
Trường
keyPairId

string

Chỉ có đầu ra. Mã nhận dạng không thể thay đổi cho cặp khoá S/MIME mã hoá phía máy khách.
pkcs7

string

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

string

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

string

Chỉ có đầu ra. Danh tính địa chỉ email được chỉ định trên leaf certificate.
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 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 theo múi giờ "Zulu" RFC3339 (giờ UTC) với độ phân giải nano giây và lên đến 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 trường hợp về 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 Trạng thái hiện tại của cặp khoá chưa được đặt. Bạn không bật cũng như tắt cặp khoá.
enabled

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

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

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

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

CsePrivateKeyMetadata

Siêu dữ liệu về một phiên bản 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.
}
Trường
privateKeyMetadataId

string

Chỉ có đầu ra. Mã không thể thay đổi cho thực thể siêu dữ liệu về khoá riêng tư.
Trường kết hợp metadata_variant. Trường kết hợp: 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ề phiên bản khoá riêng tư do dịch vụ danh sách kiểm soát quyền truy cập vào 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ề các khoá riêng tư do dịch vụ danh sách kiểm soát quyền truy cập vào 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 API CSE của Google Workspace.

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

string

URI của dịch vụ danh sách kiểm soát quyền truy cập vào 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 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
}
Trường
description

string

Nội dung mô tả về khoá phần cứng.

Phương thức

create

 Tạo và tải lên chuỗi chứng chỉ khoá công khai S/MIME được mã hoá phía máy khách 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 cho người dùng đã xác thực.

obliterate

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