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

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

enum (EnablementState)

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

string (Timestamp format)

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

ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็นรูปแบบ Z เสมอ และใช้ตัวเลขเศษส่วน 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,

  "kaclsKeyMetadata": {
    object (KaclsKeyMetadata)
  },
  "hardwareKeyMetadata": {
    object (HardwareKeyMetadata)
  }
}
ช่อง
privateKeyMetadataId

string

เอาต์พุตเท่านั้น รหัสที่เปลี่ยนแปลงไม่ได้สำหรับอินสแตนซ์ข้อมูลเมตาของคีย์ส่วนตัว
ฟิลด์ Union metadata_variant ฟิลด์สหภาพ: ต้องมีประเภทตัวแปรข้อมูลเมตาต่อไปนี้อย่างใดอย่างหนึ่ง 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

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