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 pribadinya yang dipasangkan. 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 terkirim.
  • Mendekripsi pesan S/MIME masuk atau yang diarsipkan.

Untuk administrator yang mengelola identitas dan pasangan kunci bagi pengguna di organisasi mereka, permintaan memerlukan otorisasi dengan akun layanan yang memiliki otoritas delegasi seluruh domain untuk meniru identitas pengguna dengan cakupan https://www.googleapis.com/auth/gmail.settings.basic.

Untuk pengguna yang mengelola identitas dan pasangan kunci mereka sendiri, permintaan memerlukan enkripsi kunci hardware yang diaktifkan dan dikonfigurasi.

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 serta armor ASCII.
pem

string

Hanya output. Kunci publik dan rantai sertifikasinya, 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 dalam status DISABLED.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. 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 maupun dinonaktifkan.
enabled

Pasangan kunci diaktifkan. Untuk setiap pesan email yang dienkripsi oleh pasangan kunci ini, Gmail akan 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 maupun 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,

  "kaclsKeyMetadata": {
    object (KaclsKeyMetadata)
  },
  "hardwareKeyMetadata": {
    object (HardwareKeyMetadata)
  }
}
Kolom
privateKeyMetadataId

string

Hanya output. ID yang tidak dapat diubah untuk instance metadata kunci pribadi.
Kolom union metadata_variant. Bidang gabungan: Tepat satu jenis varian metadata berikut harus ada. 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 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.

Jika enkripsi kunci hardware disiapkan untuk organisasi Google Workspace, pengguna dapat menyimpan kunci pribadi mereka di kartu smart dan menggunakannya untuk menandatangani dan mendekripsi pesan email di Gmail dengan memasukkan kartu smart ke pembaca yang terpasang ke perangkat Windows mereka.

Representasi JSON 
{
  "description": string
}
Kolom
description

string

Deskripsi tentang kunci hardware.

Metode

create

 Membuat dan mengupload rantai sertifikat kunci publik S/MIME dan metadata kunci pribadi enkripsi sisi klien 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 terautentikasi.

obliterate

 Menghapus pasangan kunci enkripsi sisi klien secara permanen dan langsung.