REST Resource: users.settings.cse.keypairs

Zasób: CseKeyPara

Para kluczy S/MIME szyfrowania po stronie klienta, która składa się z klucza publicznego, łańcucha certyfikatów i metadanych sparowanego klucza prywatnego. Gmail używa pary kluczy do wykonywania następujących zadań:

  • Podpisywanie wychodzących wiadomości zaszyfrowanych po stronie klienta.
  • zapisywać i otwierać wersje robocze wiadomości zaszyfrowanych po stronie klienta.
  • zapisywać i otwierać ponownie wysłane wiadomości,
  • Odszyfrowywanie przychodzących i zarchiwizowanych wiadomości S/MIME.
Zapis JSON
{
  "keyPairId": string,
  "pkcs7": string,
  "pem": string,
  "subjectEmailAddresses": [
    string
  ],
  "enablementState": enum (EnablementState),
  "disableTime": string,
  "privateKeyMetadata": [
    {
      object (CsePrivateKeyMetadata)
    }
  ]
}
Pola
keyPairId

string

Tylko dane wyjściowe. Niezmienny identyfikator pary kluczy S/MIME szyfrowania po stronie klienta.

pkcs7

string

Tylko dane wejściowe. Klucz publiczny i jego łańcuch certyfikatów. Łańcuch musi mieć format PKCS#7 i korzystać z kodowania PEM oraz kodowania ASCII.

pem

string

Tylko dane wyjściowe. Klucz publiczny i jego łańcuch certyfikatów w formacie PEM.

subjectEmailAddresses[]

string

Tylko dane wyjściowe. Tożsamości adresów e-mail określone w certyfikacie liścia.

enablementState

enum (EnablementState)

Tylko dane wyjściowe. Bieżący stan pary kluczy.

disableTime

string (Timestamp format)

Tylko dane wyjściowe. Jeśli para kluczy jest ustawiona na DISABLED, czas zmiany jej stanu z ENABLED na DISABLED. To pole jest dostępne tylko wtedy, gdy para kluczy ma stan DISABLED.

Sygnatura czasowa w formacie RFC3339 UTC „Zulu”, z rozdzielczością nanosekundy i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

privateKeyMetadata[]

object (CsePrivateKeyMetadata)

Metadane instancji klucza prywatnego tej pary kluczy.

EnablementState

Wyliczenie bieżącego stanu pary kluczy.

Wartości w polu enum
stateUnspecified Bieżący stan pary kluczy nie jest ustawiony. Para kluczy nie jest włączona ani wyłączona.
enabled

Para kluczy jest włączona. W przypadku e-maili szyfrowanych za pomocą tej pary kluczy Gmail odszyfrowuje wiadomości i podpisuje każdą wychodzącą pocztę kluczem prywatnym.

Aby włączyć parę kluczy, użyj metody keypairs.enable.

disabled

Para kluczy jest wyłączona. Uwierzytelnieni użytkownicy nie mogą odszyfrowywać e-maili ani podpisywać e-maili wychodzących. Jeśli para kluczy jest wyłączona przez ponad 30 dni, możesz ją trwale usunąć.

Aby wyłączyć parę kluczy, użyj metody keypairs.disable.

CsePrivateKeyMetadata

Metadane instancji klucza prywatnego.

Zapis JSON
{
  "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.
}
Pola
privateKeyMetadataId

string

Tylko dane wyjściowe. Stały identyfikator instancji metadanych klucza prywatnego.

Pole sumy metadata_variant. Pole sumy: musi istnieć dokładnie jeden z tych typów wariantów metadanych. metadata_variant może mieć tylko jedną z tych wartości:
kaclsKeyMetadata

object (KaclsKeyMetadata)

Metadane instancji klucza prywatnego zarządzanej przez zewnętrzną usługę listy kontroli dostępu do kluczy.

hardwareKeyMetadata

object (HardwareKeyMetadata)

Metadane kluczy sprzętowych.

KaclsKeyMetadata

Metadane kluczy prywatnych zarządzanych przez zewnętrzną usługę listy kontroli dostępu do kluczy. Więcej informacji o zarządzaniu dostępem do klucza znajdziesz w dokumentacji interfejsu Google Workspace CSE API.

Zapis JSON
{
  "kaclsUri": string,
  "kaclsData": string
}
Pola
kaclsUri

string

Identyfikator URI usługi listy kontroli dostępu do kluczy, która zarządza kluczem prywatnym.

kaclsData

string

Nieprzezroczyste dane generowane i używane przez usługę listy kontroli dostępu do kluczy. Maksymalny rozmiar: 8 KiB.

HardwareKeyMetadata

Metadane kluczy sprzętowych.

Zapis JSON
{
  "description": string
}
Pola
description

string

Opis klucza sprzętowego.

Metody

create

Tworzy i przesyła łańcuch certyfikatów publicznego klucza publicznego S/MIME S/MIME oraz metadane klucza prywatnego dla uwierzytelnionego użytkownika.

disable

Wyłącza parę kluczy szyfrowania po stronie klienta.

enable

Włącza wyłączoną parę kluczy szyfrowania po stronie klienta.

get

Pobiera istniejącą parę kluczy szyfrowania po stronie klienta.

list

Wyświetla pary kluczy szyfrowania po stronie klienta dla uwierzytelnionego użytkownika.

obliterate

Trwale i natychmiast usuwa parę kluczy szyfrowania po stronie klienta.