REST Resource: users.settings.cse.keypairs

ทรัพยากร: CseKeyPair

คู่คีย์ S/MIME ที่เข้ารหัสฝั่งไคลเอ็นต์ ซึ่งประกอบด้วยคีย์สาธารณะ เชนใบรับรอง และข้อมูลเมตาของคีย์ส่วนตัวที่จับคู่ไว้ Gmail ใช้คู่คีย์เพื่อดำเนินการต่อไปนี้

  • เซ็นชื่อข้อความที่เข้ารหัสฝั่งไคลเอ็นต์ขาออก
  • บันทึกและเปิดร่างข้อความที่เข้ารหัสฝั่งไคลเอ็นต์อีกครั้ง
  • บันทึกและเปิดข้อความที่ส่งไปแล้วอีกครั้ง
  • ถอดรหัสข้อความ S/MIME ขาเข้าหรือที่เก็บถาวร

สําหรับผู้ดูแลระบบที่จัดการข้อมูลระบุตัวตนและคู่คีย์สําหรับผู้ใช้ในองค์กร คําขอต้องได้รับอนุญาตด้วยบัญชีบริการที่มีสิทธิ์มอบหมายทั่วทั้งโดเมนเพื่อแอบอ้างเป็นผู้ใช้ที่มีขอบเขต https://www.googleapis.com/auth/gmail.settings.basic

สำหรับผู้ใช้ที่จัดการข้อมูลประจำตัวและคู่คีย์ของตนเอง คำขอจะต้องเปิดและกำหนดค่าการเข้ารหัสคีย์ฮาร์ดแวร์

การแสดง JSON 
{
  "keyPairId": string,
  "pkcs7": string,
  "pem": string,
  "subjectEmailAddresses": [
    string
  ],
  "enablementState": enum (EnablementState),
  "disableTime": string,
  "privateKeyMetadata": [
    {
      object (CsePrivateKeyMetadata)
    }
  ]
}
ช่อง
keyPairId

string

เอาต์พุตเท่านั้น รหัสที่ไม่เปลี่ยนแปลงสำหรับคู่คีย์ S/MIME ของการเข้ารหัสฝั่งไคลเอ็นต์
pkcs7

string

อินพุตเท่านั้น คีย์สาธารณะและเชนใบรับรอง เชนต้องอยู่ในรูปแบบ PKCS#7 และใช้การเข้ารหัส PEM และ ASCII Armor
pem

string

เอาต์พุตเท่านั้น คีย์สาธารณะและเชนใบรับรองในรูปแบบ PEM
subjectEmailAddresses[]

string

เอาต์พุตเท่านั้น ข้อมูลประจำตัวของอีเมลที่ระบุไว้ในใบรับรองระดับใบไม้
enablementState

enum (EnablementState)

เอาต์พุตเท่านั้น สถานะปัจจุบันของคู่คีย์
disableTime

string (Timestamp format)

เอาต์พุตเท่านั้น หากตั้งค่าคู่คีย์เป็น DISABLED แสดงเวลาที่สถานะของคู่คีย์เปลี่ยนจาก ENABLED เป็น DISABLED ช่องนี้จะปรากฏขึ้นเมื่อคู่คีย์อยู่ในสถานะ DISABLED เท่านั้น

ใช้ RFC 3339 ซึ่งเอาต์พุตที่สร้างขึ้นจะเป็นรูปแบบ Z-normalized เสมอ และใช้ตัวเลขทศนิยม 0, 3, 6 หรือ 9 ระบบยังยอมรับออฟเซตอื่นๆ นอกเหนือจาก "Z" ด้วย ตัวอย่างเช่น "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"
privateKeyMetadata[]

object (CsePrivateKeyMetadata)

ข้อมูลเมตาสำหรับอินสแตนซ์ของคีย์ส่วนตัวของคู่คีย์นี้

EnablementState

การแจกแจงสถานะปัจจุบันของคู่คีย์

Enum
stateUnspecified ยังไม่ได้ตั้งค่าสถานะปัจจุบันของคู่คีย์ ไม่ได้เปิดหรือปิดคู่คีย์
enabled

คู่คีย์เปิดอยู่ สำหรับข้อความอีเมลที่คู่คีย์นี้เข้ารหัส Gmail จะถอดรหัสข้อความและลงนามในอีเมลขาออกด้วยคีย์ส่วนตัว

หากต้องการเปิดคู่คีย์ ให้ใช้วิธีการ keypairs.enable
disabled

คู่คีย์ปิดอยู่ ผู้ใช้ที่ตรวจสอบสิทธิ์จะถอดรหัสข้อความอีเมลหรือลงนามในข้อความขาออกไม่ได้ หากคู่คีย์ปิดอยู่นานกว่า 30 วัน คุณจะลบคู่คีย์ดังกล่าวอย่างถาวรได้

หากต้องการปิดคู่คีย์ ให้ใช้เมธอด keypairs.disable

CsePrivateKeyMetadata

ข้อมูลเมตาสำหรับอินสแตนซ์คีย์ส่วนตัว

การแสดง 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.
}
ช่อง
privateKeyMetadataId

string

เอาต์พุตเท่านั้น รหัสแบบคงที่สำหรับอินสแตนซ์ข้อมูลเมตาของคีย์ส่วนตัว
ฟิลด์สหภาพ metadata_variant ฟิลด์ยูเนียน: ต้องมีตัวแปรข้อมูลเมตาประเภทใดประเภทหนึ่งต่อไปนี้อย่างน้อย 1 รายการ metadata_variant ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
kaclsKeyMetadata

object (KaclsKeyMetadata)

ข้อมูลเมตาสำหรับอินสแตนซ์คีย์ส่วนตัวที่จัดการโดยบริการรายการควบคุมการเข้าถึงคีย์ภายนอก
hardwareKeyMetadata

object (HardwareKeyMetadata)

ข้อมูลเมตาสำหรับคีย์ฮาร์ดแวร์

KaclsKeyMetadata

ข้อมูลเมตาสำหรับคีย์ส่วนตัวที่จัดการโดยบริการรายการควบคุมการเข้าถึงคีย์ภายนอก โปรดดูรายละเอียดเกี่ยวกับการจัดการสิทธิ์เข้าถึงคีย์ที่หัวข้อข้อมูลอ้างอิง Google Workspace CSE API

การแสดง JSON 
{
  "kaclsUri": string,
  "kaclsData": string
}
ช่อง
kaclsUri

string

URI ของบริการรายการควบคุมการเข้าถึงคีย์ที่จัดการคีย์ส่วนตัว
kaclsData

string

ข้อมูลที่ไม่สามารถมองเห็นได้ซึ่งบริการรายการควบคุมการเข้าถึงคีย์สร้างขึ้นและใช้ ขนาดสูงสุด: 8 KiB

HardwareKeyMetadata

ข้อมูลเมตาสำหรับคีย์ฮาร์ดแวร์

หากตั้งค่าการเข้ารหัสคีย์ฮาร์ดแวร์สำหรับองค์กร Google Workspace ไว้ ผู้ใช้จะจัดเก็บคีย์ส่วนตัวไว้ในสมาร์ทการ์ดและนำไปใช้ลงนามและถอดรหัสข้อความอีเมลใน Gmail ได้โดยเสียบสมาร์ทการ์ดลงในเครื่องอ่านที่เชื่อมต่อกับอุปกรณ์ Windows

การแสดง JSON 
{
  "description": string
}
ช่อง
description

string

คําอธิบายเกี่ยวกับคีย์ฮาร์ดแวร์

เมธอด

create

 สร้างและอัปโหลดเชนใบรับรอง S/MIME คีย์สาธารณะสำหรับการเข้ารหัสฝั่งไคลเอ็นต์และข้อมูลเมตาของคีย์ส่วนตัวสำหรับผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว

disable

 ปิดคู่คีย์การเข้ารหัสฝั่งไคลเอ็นต์

enable

 เปิดคู่คีย์การเข้ารหัสฝั่งไคลเอ็นต์ที่ปิดอยู่

get

 ดึงข้อมูลคู่คีย์การเข้ารหัสฝั่งไคลเอ็นต์ที่มีอยู่

list

 แสดงรายการคู่คีย์การเข้ารหัสฝั่งไคลเอ็นต์สําหรับผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว

obliterate

 ลบคู่คีย์การเข้ารหัสฝั่งไคลเอ็นต์อย่างถาวรและทันที