REST Resource: users.settings.cse.keypairs

Tài nguyên: CseKeyPair

Một cặp khoá S/MIME tính năng mã hoá phía máy khách, bao gồm một khoá công khai, chuỗi chứng chỉ của khoá đó 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 tất các việc sau:

  • Ký các thư đi được mã hoá phía máy khách.
  • 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 tin nhắn đã gửi.
  • Giải mã thư S/MIME đến hoặc đã 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 một 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 bằng phạm vi https://www.googleapis.com/auth/gmail.settings.basic.

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

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 thay đổi cho cặp khoá S/MIME tính năng mã hoá phía máy khách.
pkcs7

string

Chỉ có đầu vào. Khoá công khai và chuỗi chứng chỉ của khoá đó. Chuỗi này phải ở định dạng PKCS#7 và sử dụng phương thức mã hoá PEM cũng như 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ì đây là thời gian 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.

Hãy dùng RFC 3339, trong đó dữ liệu đầu ra được tạo sẽ luôn được chuẩn hoá theo múi giờ và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các khoảng lệch 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 phiên bản của khoá riêng tư trong cặp khoá này.

EnablementState

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

Enum
stateUnspecified Chưa đặt trạng thái hiện tại của cặp khoá. Cặp khoá này không được bật cũng không được tắt.
enabled

Cặp khoá đang bật. Đối với mọi thư 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 dùng phương thức keypairs.enable.
disabled

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

Để tắt một cặp khoá, hãy 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,

  "kaclsKeyMetadata": {
    object (KaclsKeyMetadata)
  },
  "hardwareKeyMetadata": {
    object (HardwareKeyMetadata)
  }
}
Trường
privateKeyMetadataId

string

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

object (KaclsKeyMetadata)

Siêu dữ liệu cho một phiên bản khoá riêng tư do dịch vụ danh sách kiểm soát quyền truy cập chứa 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 các khoá riêng tư do một dịch vụ danh sách kiểm soát quyền truy cập chứa 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 không rõ ràng 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 mã hoá khoá vật lý cho tổ chức Google Workspace, thì người dùng có thể tuỳ ý lưu khoá riêng tư trên thẻ thông minh và dùng khoá đó để ký cũng như giải mã thư trong Gmail bằng cách cắm thẻ thông minh vào một đầu đọc được gắn vào 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á vật lý.

Phương thức

create

 Tạo và tải lên chuỗi chứng chỉ khoá công khai S/MIME tính năng 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 một cặp khoá tính năng mã hoá phía máy khách.

enable

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

get

 Truy xuất một cặp khoá tính năng 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á tính năng mã hoá phía máy khách.