REST Resource: users.settings.cse.keypairs

Kaynak: CseKeyPair

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

  • Giden istemci tarafı şifrelenmiş iletileri imzalama.
  • İstemci tarafında şifrelenmiş iletilerin taslaklarını kaydedip yeniden açabilirsiniz.
  • Gönderilen mesajları kaydedip yeniden açabilirsiniz.
  • 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 değişmeyen kimlik.

pkcs7

string

Yalnızca giriş. Ortak anahtar ve sertifika zinciri. Zincir PKCS#7 biçiminde olmalı, PEM kodlaması ve ASCII zırhı kullanmalıdır.

pem

string

Yalnızca çıkış. Ortak anahtar ve sertifika zinciri, PEM biçiminde.

subjectEmailAddresses[]

string

Yalnızca çıkış. Yaprak sertifikada 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 ayarlanmışsa anahtar çiftinin durumu ENABLED'dan DISABLED'e değiştiği zaman. Bu alan yalnızca anahtar çifti DISABLED durumundayken mevcuttur.

Oluşturulan çıktının her zaman Z normalleştirileceği ve 0, 3, 6 veya 9 kesirli basamak kullanacağı RFC 3339'u kullanır. "Z" dışındaki ofsetler de 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 örnekleri için meta veriler.

EnablementState

Anahtar çiftinin mevcut durumunu gösteren listeleme.

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

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

Bir anahtar çiftini açmak için keypairs.enable yöntemini kullanın.

disabled

Anahtar çifti devre dışıdır. Kimliği doğrulanmış kullanıcılar e-posta iletilerinin şifresini çözemez veya giden iletileri imzalayamaz. 30 günden uzun süredir devre dışı olan bir anahtar çiftini kalıcı olarak silebilirsiniz.

Bir anahtar çiftini kapatmak 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 değişmeyen kimliği.

Birlik alanı metadata_variant. Birleştirme alanı: Aşağıdaki meta veri varyantı türlerinden tam olarak biri bulunmalıdır. metadata_variant yalnızca aşağıdakilerden 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ı için 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 İ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 opak veriler. Maksimum boyut: 8 KiB.

HardwareKeyMetadata

donanım anahtarları için meta veriler.

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