REST Resource: users.settings.cse.keypairs

ทรัพยากร: CseKeypair

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

  • ลงชื่อข้อความขาออกที่เข้ารหัสฝั่งไคลเอ็นต์
  • บันทึกและเปิดฉบับร่างของข้อความที่เข้ารหัสฝั่งไคลเอ็นต์อีกครั้ง
  • บันทึกและเปิดข้อความที่ส่งแล้วอีกครั้ง
  • ถอดรหัสข้อความ S/MIME ขาเข้าหรือที่เก็บถาวร
การแสดง 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
pem

string

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

string

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

enum (EnablementState)

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

string (Timestamp format)

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

การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่มีความละเอียดระดับนาโนวินาทีและมีตัวเลขเศษส่วนได้สูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"
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

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

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

string

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

string

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

HardwareKeyMetadata

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

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

string

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

วิธีการ

create

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

disable

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

enable

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

get

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

list

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

obliterate

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