REST Resource: users.settings.cse.keypairs

Kaynak: CseKeyPair

Ortak anahtar, sertifika zinciri ve eşleştirilmiş özel anahtarının meta verilerinden oluşan istemci tarafı şifreleme S/MIME anahtar çifti. Gmail, aşağıdaki görevleri tamamlamak için anahtar çiftini kullanır:

  • Giden istemci tarafında şifrelenmiş iletileri imzalama
  • İstemci tarafı şifreleme uygulanmış iletilerin taslaklarını kaydedip yeniden açabilirsiniz.
  • Gönderilen mesajları kaydedip yeniden açabilirsiniz.
  • Gelen veya arşivlenen S/MIME iletilerinin şifresini çözme

Kuruluşlarındaki kullanıcıların kimliklerini ve anahtar çiftlerini yöneten yöneticiler için, isteklerin https://www.googleapis.com/auth/gmail.settings.basic kapsamıyla kullanıcıların kimliğine bürünmek üzere alan genelinde yetki devri yetkisine sahip bir hizmet hesabıyla yetkilendirilmesi gerekir.

Kendi kimliklerini ve anahtar çiftlerini yöneten kullanıcılar için isteklerde donanım anahtarı şifrelemesinin etkinleştirilmesi ve yapılandırılması gerekir.

JSON gösterimi 
{
  "keyPairId": string,
  "pkcs7": string,
  "pem": string,
  "subjectEmailAddresses": [
    string
  ],
  "enablementState": enum (EnablementState),
  "disableTime": string,
  "privateKeyMetadata": [
    {
      object (CsePrivateKeyMetadata)
    }
  ]
}
Alanlar
keyPairId

string

Yalnızca çıkış. İstemci tarafı şifreleme S/MIME anahtar çifti için değişmez kimlik.
pkcs7

string

Yalnızca giriş. Ortak anahtar ve sertifika zinciri. Zincir PKCS#7 biçiminde olmalı, PEM kodlaması ve ASCII armor kullanılmalıdır.
pem

string

Yalnızca çıkış. Ortak anahtar ve sertifika zinciri PEM biçiminde olmalıdır.
subjectEmailAddresses[]

string

Yalnızca çıkış. Yaprak sertifikasında belirtilen e-posta adresi kimlikleri.
enablementState

enum (EnablementState)

Yalnızca çıkış. Anahtar çiftinin mevcut durumu.
disableTime

string (Timestamp format)

Yalnızca çıkış. Bir anahtar çifti DISABLED olarak ayarlanırsa anahtar çiftinin durumunun ENABLED'den DISABLED'ya değiştiği zaman. Bu alan yalnızca anahtar çifti DISABLED durumundayken bulunur.

Zaman damgasında RFC 3339 kullanılır. Yani oluşturulan çıkış her zaman Z ile normalleştirilir ve 0, 3, 6 veya 9 kesirli basamak kullanılır. "Z" dışındaki zaman farkları da kabul edilir. Örnekler: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" veya "2014-10-02T15:01:23+05:30".
privateKeyMetadata[]

object (CsePrivateKeyMetadata)

Bu anahtar çiftinin özel anahtarının örnekleriyle ilgili meta veriler.

EnablementState

Anahtar çiftinin mevcut durumunun numaralandırması.

Sıralamalar
stateUnspecified Anahtar çiftinin mevcut durumu ayarlanmamış. Anahtar çifti ne etkinleştirilmiş ne de devre dışı bırakılmış.
enabled

Anahtar çifti etkinleştirilmiş olmalıdır. Bu anahtar çiftinin şifrelediği tüm e-posta iletilerinin şifresini Gmail çözer ve giden tüm postaları özel anahtarla imzalar.

Bir anahtar çiftini etkinleştirmek için keypairs.enable yöntemini kullanın.
disabled

Anahtar çifti devre dışı bırakılır. Kimliği doğrulanmış kullanıcılar, e-posta iletilerinin şifresini çözemez veya giden iletileri imzalayamaz. Bir anahtar çifti 30 günden uzun süre devre dışı bırakılırsa kalıcı olarak silebilirsiniz.

Bir anahtar çiftini devre dışı bırakmak için keypairs.disable yöntemini kullanın.

CsePrivateKeyMetadata

Özel anahtar örneğinin meta verileri.

JSON gösterimi 
{
  "privateKeyMetadataId": string,

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

string

Yalnızca çıkış. Özel anahtar meta veri örneğinin değişmez kimliği.
metadata_variant birleşik alanı. Birleşim alanı: Aşağıdaki meta veri varyantı türlerinden tam olarak biri bulunmalıdır. metadata_variant aşağıdakilerden yalnızca biri olabilir:
kaclsKeyMetadata

object (KaclsKeyMetadata)

Harici bir anahtar erişim kontrol listesi hizmeti tarafından yönetilen özel anahtar örneğinin meta verileri.
hardwareKeyMetadata

object (HardwareKeyMetadata)

Donanım anahtarlarıyla ilgili meta veriler.

KaclsKeyMetadata

Harici bir anahtar erişim kontrol listesi hizmeti tarafından yönetilen özel anahtarlarla ilgili meta veriler. Anahtar erişimini yönetme hakkında ayrıntılı bilgi için Google Workspace CSE API Referansı başlıklı makaleyi inceleyin.

JSON gösterimi 
{
  "kaclsUri": string,
  "kaclsData": string
}
Alanlar
kaclsUri

string

Özel anahtarı yöneten anahtar erişim kontrol listesi hizmetinin URI'si.
kaclsData

string

Anahtar erişim kontrol listesi hizmeti tarafından oluşturulan ve kullanılan opak veriler. Maksimum boyut: 8 KiB.

HardwareKeyMetadata

Donanım anahtarlarıyla ilgili meta veriler.

Google Workspace kuruluşunda donanım anahtarı şifrelemesi ayarlanmışsa kullanıcılar özel anahtarlarını isteğe bağlı olarak akıllı kartlarında saklayabilir ve akıllı kartlarını Windows cihazlarına bağlı bir okuyucuya takarak Gmail'deki e-posta iletilerini imzalamak ve şifrelerini çözmek için kullanabilir.

JSON gösterimi 
{
  "description": string
}
Alanlar
description

string

Donanım anahtarı hakkında açıklama.

Yöntemler

create

 Kimliği doğrulanmış kullanıcı için istemci tarafı şifreleme S/MIME ortak anahtar sertifika zinciri ve özel anahtar meta verileri oluşturup yükler.

disable

 İstemci tarafı şifreleme anahtar çiftini devre dışı bırakır.

enable

 Devre dışı bırakılmış bir istemci tarafı şifreleme anahtar çiftini etkinleştirir.

get

 Mevcut bir istemci tarafı şifreleme anahtar çiftini alır.

list

 Kimliği doğrulanmış bir kullanıcının istemci tarafı şifreleme anahtar çiftlerini listeler.

obliterate

 İstemci tarafı şifreleme anahtarı çiftini kalıcı olarak ve hemen siler.