REST Resource: users.settings.cse.keypairs

Kaynak: CseKeyPair

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

  • İstemci tarafında şifrelenmiş giden iletileri imzalayın.
  • İstemci tarafında şifrelenmiş iletilerin taslaklarını kaydedip yeniden açın.
  • Gönderilen iletileri kaydedip yeniden açın.
  • Gelen veya arşivlenen S/MIME iletilerinin şifresini çözün.
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 çiftinin sabit kimliği.
pkcs7

string

Yalnızca giriş. Ortak anahtar ve sertifika zinciri. Zincirin PKCS#7 biçiminde olması ve PEM kodlaması ile ASCII zırhı kullanması gerekir.
pem

string

Yalnızca çıkış. PEM biçimindeki ortak anahtar ve sertifika zinciri.
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 değerine ayarlanırsa anahtar çiftinin ENABLED olan durumunun DISABLED olarak değiştiği zaman. Bu alan yalnızca anahtar çifti DISABLED durumunda olduğunda bulunur.

RFC3339 UTC "Zulu" zaman damgası biçiminde olmalıdır. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".
privateKeyMetadata[]

object (CsePrivateKeyMetadata)

Bu anahtar çiftinin özel anahtar örneklerinin meta verileri.

EnablementState

Anahtar çiftinin mevcut durumunun numaralandırması.

Sıralamalar
stateUnspecified Anahtar çiftinin mevcut durumu ayarlanmamış. Anahtar çifti açık veya kapalı değil.
enabled

Anahtar çifti açılır. Bu anahtar çiftinin şifrelediği tüm e-posta iletileri için Gmail, iletilerin şifresini çözer ve giden postaları özel anahtarla imzalar.

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

Anahtar çifti kapatı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,

  // 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.
}
Alanlar
privateKeyMetadataId

string

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

object (KaclsKeyMetadata)

Harici bir anahtar erişim kontrol listesi hizmeti tarafından yönetilen bir ö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 anahtarların meta verileri. Anahtar erişimini yönetmeyle ilgili ayrıntılar için Google Workspace İTŞ 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 şeffaf veriler. Maksimum boyut: 8 KiB.

HardwareKeyMetadata

Donanım anahtarlarıyla ilgili meta veriler.

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

string

Donanım anahtarıyla ilgili açıklama.

Yöntemler

create

 Kimliği doğrulanmış kullanıcı için istemci tarafı şifreleme S/MIME ortak anahtar sertifikası 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ılan 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ı için istemci tarafı şifreleme anahtarı çiftlerini listeler.

obliterate

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