REST Resource: users.settings.cse.keypairs

Kaynak: CseKeyEşleme

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

  • Giden istemci tarafında şifrelenmiş 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 çözme.
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 sabit kimlik.
pkcs7

string

Yalnızca giriş. Ortak anahtar ve sertifika zinciri. Zincir, PKCS#7 biçiminde olmalı ve PEM kodlaması ile ASCII zırhı kullanmalıdır.
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 durumundayken gösterilir.

Nanosaniye çözünürlüğe ve en fazla dokuz kesir basamağına sahip, RFC3339 UTC "Zulu" biçiminde bir zaman damgası. Ö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 sıralaması.

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

Anahtar çifti açık olmalıdır. Gmail, bu anahtar çiftinin şifrelediği tüm e-posta iletileri için 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 devre dışı bırakıldı. Kimliği doğrulanmış kullanıcılar e-posta iletilerinin şifresini çözemez veya giden iletileri imzalayamaz. 30 günden uzun süre boyunca kapalı kalan anahtar çiftleri 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.
metadata_variant alanı. Birlik alanı: Aşağıdaki meta veri varyantı türlerinden tam olarak biri mevcut olmalıdır. metadata_variant şunlardan yalnızca biri olabilir:
kaclsKeyMetadata

object (KaclsKeyMetadata)

Harici 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 anahtarların meta verileri. 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.

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 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.