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 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 nhiệm vụ sau:

  • Ký thư đi được mã hoá phía máy khách.
  • Lưu và mở lại thư nháp được mã hoá phía máy khách.
  • Lưu và mở lại thư đã gửi.
  • Giải mã thư S/MIME đến hoặc thư đã lưu trữ.

Đố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.

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 và sử dụng bộ mã hoá PEM và lớp bảo vệ 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 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 một cặp khoá được đặt thành DISABLED, thì thời điểm trạng thái của cặp khoá 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.

Sử dụng RFC 3339, trong đó đầu ra được tạo sẽ luôn được chuẩn hoá theo Z và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các độ dời khác ngoài "Z" cũng được chấp nhận. Ví dụ: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" hoặc "2014-10-02T15:01:23+05:30".
privateKeyMetadata[]

object (CsePrivateKeyMetadata)

Siêu dữ liệu cho các thực thể của khoá riêng tư của cặp khoá này.

EnablementState

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. Cặp khoá chưa được bật hoặc tắt.
enabled

Cặp khoá đã được bật. Đối với mọi thư 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á đang tắt. Người dùng đã xác thực không thể giải mã thư 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 cho một 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.
}
Trường
privateKeyMetadataId

string

Chỉ có đầu ra. Mã nhận dạng không thể thay đổi của thực thể siêu dữ liệu khoá riêng tư.
Trường hợp hợp nhất metadata_variant. Trường hợp 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 loại sau:
kaclsKeyMetadata

object (KaclsKeyMetadata)

Siêu dữ liệu cho một thực thể 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 cho khoá phần cứng.

KaclsKeyMetadata

Siêu dữ liệu cho khoá riêng tư do 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 vào 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
}
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 và sử dụng. Kích thước tối đa: 8 KiB.

HardwareKeyMetadata

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

Nếu bạn thiết lập tính năng mã hoá khoá phần cứng cho tổ chức Google Workspace, người dùng có thể tuỳ ý lưu trữ khoá riêng tư trên thẻ thông minh và sử dụng khoá đó để ký và giải mã thư email trong Gmail bằng cách chèn thẻ thông minh vào đầu đọc gắn với thiết bị Windows.

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 chuỗi chứng chỉ khoá công khai S/MIME mã hoá phía máy khách và siêu dữ liệu khoá riêng tư lên 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 một cặp khoá mã hoá phía máy khách đã bị tắt.

get

 Truy xuất mộ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 một 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.