REST Resource: users.settings.cse.keypairs

Resource: CseKeyPair

Pasangan kunci S/MIME enkripsi sisi klien, yang terdiri dari kunci publik, rantai sertifikatnya, dan metadata untuk kunci pribadi yang disambungkan. Gmail menggunakan pasangan kunci untuk menyelesaikan tugas berikut:

  • Menandatangani pesan terenkripsi sisi klien yang keluar.
  • Menyimpan dan membuka kembali draf pesan terenkripsi sisi klien.
  • Menyimpan dan membuka kembali pesan yang dikirim.
  • Mendekripsi pesan S/MIME masuk atau yang diarsipkan.
Representasi JSON 
{
  "keyPairId": string,
  "pkcs7": string,
  "pem": string,
  "subjectEmailAddresses": [
    string
  ],
  "enablementState": enum (EnablementState),
  "disableTime": string,
  "privateKeyMetadata": [
    {
      object (CsePrivateKeyMetadata)
    }
  ]
}
Kolom
keyPairId

string

Hanya output. ID yang tidak dapat diubah untuk pasangan kunci S/MIME enkripsi sisi klien.
pkcs7

string

Hanya input. Kunci publik dan rantai sertifikatnya. Rantai harus dalam format PKCS#7 dan menggunakan encoding PEM dan armor ASCII.
pem

string

Hanya output. Kunci publik dan rantai sertifikatnya, dalam format PEM.
subjectEmailAddresses[]

string

Hanya output. Identitas alamat email yang ditentukan pada sertifikat leaf.
enablementState

enum (EnablementState)

Hanya output. Status pasangan kunci saat ini.
disableTime

string (Timestamp format)

Hanya output. Jika pasangan kunci ditetapkan ke DISABLED, waktu saat status pasangan kunci berubah dari ENABLED menjadi DISABLED. Kolom ini hanya ada jika pasangan kunci berada dalam status DISABLED.

Menggunakan RFC 3339, dengan output yang dihasilkan akan selalu dinormalisasi Z dan menggunakan digit pecahan 0, 3, 6, atau 9. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
privateKeyMetadata[]

object (CsePrivateKeyMetadata)

metadata untuk instance kunci pribadi pasangan kunci ini.

EnablementState

Enumerasi untuk status pasangan kunci saat ini.

Enum
stateUnspecified Status pasangan kunci saat ini tidak ditetapkan. Pasangan kunci tidak diaktifkan atau dinonaktifkan.
enabled

Pasangan kunci diaktifkan. Untuk setiap pesan email yang dienkripsi oleh pasangan kunci ini, Gmail mendekripsi pesan dan menandatangani email keluar dengan kunci pribadi.

Untuk mengaktifkan pasangan kunci, gunakan metode keypairs.enable.
disabled

Pasangan kunci dinonaktifkan. Pengguna yang diautentikasi tidak dapat mendekripsi pesan email atau menandatangani pesan keluar. Jika pasangan kunci dinonaktifkan selama lebih dari 30 hari, Anda dapat menghapusnya secara permanen.

Untuk menonaktifkan pasangan kunci, gunakan metode keypairs.disable.

CsePrivateKeyMetadata

metadata untuk instance kunci pribadi.

Representasi 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.
}
Kolom
privateKeyMetadataId

string

Hanya output. ID yang tidak dapat diubah untuk instance metadata kunci pribadi.
Kolom union metadata_variant. Kolom gabungan: Harus ada tepat satu dari jenis varian metadata berikut. metadata_variant hanya dapat berupa salah satu dari berikut:
kaclsKeyMetadata

object (KaclsKeyMetadata)

metadata untuk instance kunci pribadi yang dikelola oleh layanan daftar kontrol akses kunci enkripsi eksternal.
hardwareKeyMetadata

object (HardwareKeyMetadata)

metadata untuk tombol hardware.

KaclsKeyMetadata

metadata untuk kunci pribadi yang dikelola oleh layanan daftar kontrol akses kunci eksternal. Untuk mengetahui detail tentang cara mengelola akses kunci, lihat Referensi Google Workspace CSE API.

Representasi JSON 
{
  "kaclsUri": string,
  "kaclsData": string
}
Kolom
kaclsUri

string

URI layanan daftar kontrol akses kunci yang mengelola kunci pribadi.
kaclsData

string

Data buram yang dibuat dan digunakan oleh layanan daftar kontrol akses kunci. Ukuran maksimum: 8 KiB.

HardwareKeyMetadata

metadata untuk tombol hardware.

Representasi JSON 
{
  "description": string
}
Kolom
description

string

Deskripsi tentang kunci hardware.

Metode

create

 Membuat dan mengupload rantai sertifikat kunci publik S/MIME enkripsi sisi klien dan metadata kunci pribadi untuk pengguna yang diautentikasi.

disable

 Menonaktifkan pasangan kunci enkripsi sisi klien.

enable

 Mengaktifkan pasangan kunci enkripsi sisi klien yang dinonaktifkan.

get

 Mengambil pasangan kunci enkripsi sisi klien yang ada.

list

 Mencantumkan pasangan kunci enkripsi sisi klien untuk pengguna yang diautentikasi.

obliterate

 Menghapus pasangan kunci enkripsi sisi klien secara permanen dan langsung.